IVSMicrophone

Objective-C

@protocol IVSMicrophone <IVSAudioDevice, IVSMultiSourceDevice>

Swift

protocol IVSMicrophone : IVSAudioDevice, IVSMultiSourceDevice

An extension of IVSAudioDevice that represents a physical microphone accessible by the host device.

  • Assign a delegate to receive updates about the attached microphone.

    Declaration

    Objective-C

    @property (nonatomic, weak) id<IVSMicrophoneDelegate> _Nullable delegate;

    Swift

    weak var delegate: (any IVSMicrophoneDelegate)? { get set }

  • Deprecated

    Echo cancellation must now be controlled throgh IVSStageAudioManager.

    Indicates whether echo cancellation is enabled on the microphone device. By default this is NO. The value reported will be the instantaneous value on the input node, because the audio is managed on a background queue, the value may be changing in the background while this is queried.

    Note

    Changing this property while the microphone is in use may result in momentary audio loss. Setting this property to a value of YES may require microphone permissions.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isEchoCancellationEnabled) BOOL echoCancellationEnabled;

    Swift

    var isEchoCancellationEnabled: Bool { get set }