TVIAudioController Class Reference

Inherits from	NSObject
Declared in	TVIAudioController.h

Overview

TVIAudioController allows you to manage audio usage in the TwilioVideo SDK.

CallKit specific additions. You should not call these methods unless your app is using CallKit.

Other Methods

`– init`

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

TVIAudioController can not be created with init.

Declared In

TVIAudioController.h

`audioOutput`

The audio output configuration for the sdk. Use this property to customize audio behavior for your particular use case. The default value is TVIAudioOutputVideoChatDefault.

@property (nonatomic, assign) TVIAudioOutput audioOutput

Declared In

TVIAudioController.h

CallKit Methods

`– configureAudioSession:`

Configures, but does not activate the AVAudioSession.

- (void)configureAudioSession:(TVIAudioOutput)audioOutput

Parameters

`audioOutput`	The audio output.

Discussion

If you are using CallKit, you must call this API before reporting a new incoming/outgoing call to CallKit or in CXProviderDelegate’s provider:performStartCallAction: or provider:performAnswerCallAction:. If you are not using CallKit then this method will be invoked on your behalf by the SDK.

Declared In

TVIAudioController.h

`– startAudio`

Starts the audio device.

- (BOOL)startAudio

Return Value

YES if the starting audio succeeds, and NO if it fails.

Discussion

If you are using CallKit, you must call this API on CXProviderDelegate’s provider:didActivateAudioSession:. and hold action provider:performSetHeldCallAction: method. If you are not using CallKit then this method will be invoked on your behalf by the SDK.

Declared In

TVIAudioController.h

`– stopAudio`

Stops the audio device.

- (void)stopAudio

Discussion

If you are using CallKit, you must call this API on CXProviderDelegate’s providerDidReset:, unhold action provider:performSetHeldCallAction: and provider:performEndCallAction: method. If you are not using CallKit then this method will be invoked on your behalf by the SDK.

Declared In

TVIAudioController.h