TVIAudioOptions Class Reference

Inherits from	NSObject
Declared in	TVIAudioOptions.h

Overview

TVIAudioOptions specifies options for TVILocalAudioTrack.

`audioJitterBufferMaxPackets`

Audio receiver jitter buffer (NetEq) max capacity in number of packets. Defaults to 50.

@property (nonatomic, assign, readonly) int audioJitterBufferMaxPackets

Declared In

TVIAudioOptions.h

`audioJitterBufferFastAccelerate`

Audio receiver jitter buffer (NetEq) fast accelerate mode. Defaults to NO.

@property (nonatomic, assign, readonly) BOOL audioJitterBufferFastAccelerate

Declared In

TVIAudioOptions.h

`softwareAecEnabled`

Enable software Acoustic Echo Cancellation (AEC). Defaults to NO.

@property (nonatomic, assign, readonly, getter=isSoftwareAecEnabled) BOOL softwareAecEnabled

Discussion

TVIDefaultAudioDevice uses Apple’s built-in hardware echo cancellation. If you are having issues with echo cancellation and TVIDefaultAudioDevice, or you’ve written your own TVIAudioDevice without echo cancellation you may wish to enable software echo cancellation instead. This API is currently experimental, and we may extend the TVIAudioDecice’s APIs to work with this property.

Declared In

TVIAudioOptions.h

`highpassFilter`

Audio processing to remove background noise of lower frequencies. Defaults to YES.

@property (nonatomic, assign, readonly) BOOL highpassFilter

Declared In

TVIAudioOptions.h

`)`

Enable audio level control. Defaults to NO.

@property (nonatomic, assign, readonly) BOOL levelControl DEPRECATED_MSG_ATTRIBUTE ( "levelControl is deprecated and setting it no longer has any effect. It will be removed in a future release." )

Discussion

This property is deprecated and setting it no longer has any effect. It will be removed in a future release.

Declared In

TVIAudioOptions.h

`+ options`

Creates default options.

+ (null_unspecified instancetype)options

Return Value

An instance of TVIAudioOptions.

Declared In

TVIAudioOptions.h

`+ optionsWithBlock:`

Constructs TVIAudioOptions using the builder pattern.

+ (null_unspecified instancetype)optionsWithBlock:(nonnull TVIAudioOptionsBuilderBlock)block

Parameters

`block`	You can pass audio options to the builder using this block. The builder will construct a `TVIAudioOptions` object using the options provided.

Return Value

An instance of TVIAudioOptions.

Declared In

TVIAudioOptions.h