MCRTSRemoteTrack Class Reference

#import <rts_remote_track.h>

Inheritance diagram for MCRTSRemoteTrack:

Collaboration diagram for MCRTSRemoteTrack:

Instance Methods
(MCRTSRemoteVideoTrack *_Nullable)	- asVideo
(MCRTSRemoteAudioTrack *_Nullable)	- asAudio
(instancetype _Nonnull)	- NS_UNAVAILABLE
(void)	- disableWithCompletionHandler:
	rtsRemoteTrackWithNativeTrack:

Properties
id< MCRTSRemoteTrackDelegate > _Nullable	delegate
	Delegate to receive track related events.
NSString *_Nullable	sourceID
	The source ID of the track's publisher.
MCRemoteTrackKind	kind
	Either an Audio or Video track.
BOOL	isActive
	Whether the track is currently active.
NSString *_Nullable	currentMID
	The current MID of the track. Useful to parse statistics based on the mid.

Detailed Description

The RTS logical track. This class represents a single media (audio or video) in the RTS stream. The RTS tracks are created automatically when the service notifies about the sources becoming active, can be used to enable simple streaming scenarios: enable projection of the audio and video coming from the same source with lip-sync, with a single video renderer attached to the video track. When the RTS source goes inactive, streaming for them is automatically disabled.

Method Documentation

asAudio

- (MCRTSRemoteAudioTrack *_Nullable) asAudio

Cast the track to it's true type if it is audio, otherwise, nil will be returned.

• Returns: Nil if the track is not of an audio type

asVideo

- (MCRTSRemoteVideoTrack *_Nullable) asVideo

Cast the track to it's true type if it is video, otherwise, nil will be returned.

• Returns: Nil if the track is not of a video type

disableWithCompletionHandler:

- (void) disableWithCompletionHandler:

(nonnull void(^)(NSError *_Nullable))

completionHandler

Disable the track. This makes the track stop receiving events/media.

• Parameters:
  • completionHandler: Invoked when the asynchronous operation finishes.

NS_UNAVAILABLE

- (instancetype _Nonnull) NS_UNAVAILABLE

Implemented in MCRTSRemoteAudioTrack, and MCRTSRemoteVideoTrack.

Property Documentation

currentMID

- (NSString* _Nullable) currentMID

readnonatomicassign

The current MID of the track. Useful to parse statistics based on the mid.

delegate

- (id<MCRTSRemoteTrackDelegate> _Nullable) delegate

readwriteatomicweak

Delegate to receive track related events.

isActive

- (BOOL) isActive

readnonatomicassign

Whether the track is currently active.

kind

- (MCRemoteTrackKind) kind

readnonatomicassign

Either an Audio or Video track.

sourceID

- (NSString* _Nullable) sourceID

readnonatomicassign

The source ID of the track's publisher.

---

The documentation for this class was generated from the following file:

• objc/MillicastSDK/rts_remote_track.h