IVSMixedAudioDeviceSourceConfiguration

Objective-C


@interface IVSMixedAudioDeviceSourceConfiguration : NSObject

Swift

class IVSMixedAudioDeviceSourceConfiguration : NSObject

Configuration for an IVSMixedAudioDeviceSource.

  • The gain of the source By default this is 1.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float gain;

    Swift

    var gain: Float { get }

  • Sets the gain applied to the output of the associated source. This must be between 0 and 2. A gain of 1 means no change. A gain less than 1 will suppress, and greater than 1 will amplify. If the provided gain falls outside this range, the gain will not be set and the provided outError will be set.

    Declaration

    Objective-C

    - (BOOL)setGain:(float)gain error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func setGain(_ gain: Float) throws

    Parameters

    gain

    The gain applied to the output of the associated source.
    outError

    On input, a pointer to an error object. If an error occurs, the pointer is an NSError object that describes the error. If you don’t want error information, pass in nil.

    Return Value

    if the set operation is successful or not.