TVILocalAudioTrack Class Reference

Inherits from	TVIAudioTrack : TVITrack : NSObject
Declared in	TVIAudioTrack.h

Overview

TVILocalAudioTrack represents an audio track where the content is captured from your device’s audio subsystem.

`options`

The TVIAudioOptions that were provided when the track was added to TVILocalMedia.

@property (nonatomic, strong, readonly, nullable) TVIAudioOptions *options

Declared In

TVIAudioTrack.h

`enabled`

Indicates if the track content is enabled.

@property (nonatomic, assign, getter=isEnabled) BOOL enabled

Discussion

It is possible to enable and disable local tracks. The results of this operation are signaled to other Participants in the same Room. When an audio track is disabled, silence is sent in place of normal audio.

Declared In

TVIAudioTrack.h

`– init`

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Tracks cannot be created explicitly.

Declared In

TVIAudioTrack.h

`+ track`

Creates a TVILocalAudioTrack with the default settings.

+ (null_unspecified instancetype)track

Return Value

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

Discussion

This method uses the default TVIAudioOptions, and produces an enabled Track.

Declared In

TVIAudioTrack.h

`+ trackWithOptions:enabled:`

Creates a TVILocalAudioTrack with TVIAudioOptions and an enabled setting.

+ (null_unspecified instancetype)trackWithOptions:(nullable TVIAudioOptions *)options enabled:(BOOL)enabled

Parameters

`options`	An instance of `TVIAudioOptions` to configure the Track.
`enabled`	Determines if the Track is enabled at creation time.

Return Value

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

Discussion

This method allows you to provide specific TVIAudioOptions, and produce a disabled Track if you wish.

Declared In

TVIAudioTrack.h