TVIRemoteVideoTrack Class Reference

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

Overview

TVIRemoteVideoTrack represents a remote video track.

  sid

The sid of the remote video track.

@property (nonatomic, copy, readonly, nonnull) NSString *sid

Declared In

TVIRemoteVideoTrack.h

  switchedOff

Get whether the track is switched off.

@property (nonatomic, assign, readonly, getter=isSwitchedOff) BOOL switchedOff

Declared In

TVIRemoteVideoTrack.h

  priority

A nullable property set by the publisher for the corresponding TVIRemoteVideoTrack.

@property (nonatomic, copy, nullable) TVITrackPriority priority

Discussion

The default subscriber priority is nil, which indicates that the subscriber has not set a priority for this TVIRemoteVideoTrack. If the TVIRemoteVideoTrack has been unsubscribed from then this will return the last set priority. Setting this property to nil clears the subscribers TVITrackPriority for this TVIRemoteVideoTrack.

Declared In

TVIRemoteVideoTrack.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Tracks cannot be created explicitly.

Declared In

TVIRemoteVideoTrack.h

– switchOff

Request to switch off a RemoteVideoTrack, if it is currently switched on.

- (void)switchOff

Discussion

This method must be called only if the clientTrackSwitchOffControl is set to manual in video bandwidth profile options.

Declared In

TVIRemoteVideoTrack.h

– switchOn

Request to switch on a RemoteVideoTrack, if it was switched off using RemoteVideoTrack.switchOff().

- (void)switchOn

Discussion

This method must be called only if the clientTrackSwitchOffControl is set to manual in video bandwidth profile options. Tracks may still remain switched off when available bandwidth is limited.

Declared In

TVIRemoteVideoTrack.h

– setContentPreferences:

Sets the TVIVideoContentPreferences for the RemoteVideoTrack.

- (void)setContentPreferences:(nonnull TVIVideoContentPreferences *)contentPreferences

Parameters

contentPreferences

The TVIVideoContentPreferences for this RemoteVideoTrack.

Discussion

This method must be called only if the contentPreferencesMode is set to manual in video bandwidth profile options.

Declared In

TVIRemoteVideoTrack.h