TVILocalVideoTrack Class Reference

Inherits from TVIVideoTrack : TVITrack : NSObject
Declared in TVILocalVideoTrack.h

Overview

TVILocalVideoTrack represents local video produced by a TVIVideoSource.

  enabled

Indicates if track 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 a video track is disabled, black frames are sent in place of normal video.

Declared In

TVILocalVideoTrack.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Use trackWithCapturer: or trackWithCapturer:enabled:constraints:name: to create a TVILocalVideoTrack.

Declared In

TVILocalVideoTrack.h

  source

The video source that is associated with this track when using the TVIVideoSource based initializers.

@property (nonatomic, strong, readonly, nullable) id<TVIVideoSource> source

Declared In

TVILocalVideoTrack.h

+ trackWithSource:

Creates a TVILocalVideoTrack with a TVIVideoSource.

+ (nullable instancetype)trackWithSource:(nonnull id<TVIVideoSource>)source

Parameters

source

A TVIVideoSource which will provide the content for this Track.

Return Value

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

Discussion

The Track will be enabled, and use a randomly generated name.

See Also

Declared In

TVILocalVideoTrack.h

+ trackWithSource:enabled:name:

Creates a TVILocalVideoTrack with a TVIVideoSource.

+ (nullable instancetype)trackWithSource:(nonnull id<TVIVideoSource>)source enabled:(BOOL)enabled name:(nullable NSString *)name

Parameters

source

A TVIVideoSource which will provide the content for this Track.
enabled

Determines if the Track is enabled at creation time.
name

A name for the Track. Names are immutable and can only be provided at Track creation time.

Return Value

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

Discussion

The Track will be enabled, and use a randomly generated name.

See Also

Declared In

TVILocalVideoTrack.h