<MCRTSRemoteTrackDelegate> Protocol Reference

A delegate to receive remote track related events. More...

#import <rts_remote_track.h>

Inheritance diagram for <MCRTSRemoteTrackDelegate>:

Collaboration diagram for <MCRTSRemoteTrackDelegate>:

Instance Methods
(void)	- rtsRemoteTrackActive:
(void)	- rtsRemoteTrackInactive:
(void)	- rtsRemoteTrack:didUpdateLayers:
(void)	- rtsRemoteTrack:didUpdateMID:

Detailed Description

A delegate to receive remote track related events.

Method Documentation

rtsRemoteTrack:didUpdateLayers:

- (void) rtsRemoteTrack: (MCRTSRemoteTrack *_Nonnull)  rtsRemoteTrack didUpdateLayers: (rtsRemoteTrack(_:didUpdateLayers:))  NS_SWIFT_NAME

optional

Event received when there is Simulcast/SVC layers available for the remote track. Only available for video tracks.

• Parameters:
  • rtsRemoteTrack: The remote track receiving the layer events.
  • rtsRemoteTrackLayers: The layer event data.

rtsRemoteTrack:didUpdateMID:

- (void) rtsRemoteTrack: (MCRTSRemoteTrack *_Nonnull)  rtsRemoteTrack didUpdateMID: (rtsRemoteTrack(_:didUpdateMID:))  NS_SWIFT_NAME

optional

Event received when the underlying WebRTC MID has changed. This can happen in cases of network dropouts or in general when the underlying peer connection has been torn down. In general, keeping the MID handy is useful when parsing MCInboundRtpStreamStats based on the mid, since each mid corresponds to one track.

• Parameters:
  • rtsRemoteTrack: The remote track receiving the mid change.
  • mid: The new mid.

rtsRemoteTrackActive:

- (void) rtsRemoteTrackActive: (MCRTSRemoteTrack *_Nonnull)  rtsRemoteTrack

optional

Event received when the track, i.e. it's publishing source, has become active. In other words the stream is being sent to the server and is viable on the viewing client. The track is not enabled by default. The application can still call disable() on this track to prevent it from being played. If the track was previously disabled, the application must call enable() for the track to be renderable. If the track was previously enabled by the application and is not disabled by the application it will automatically start playing once it becomes active.

• Parameters:
  • rtsRemoteTrack: The remote track that has become active.

rtsRemoteTrackInactive:

- (void) rtsRemoteTrackInactive: (MCRTSRemoteTrack *_Nonnull)  rtsRemoteTrack

optional

Event received when the track, i.e. it's publishing source, has become inactive. In other words the publishers stream is no longer being sent to the server and is thus no longer viewable on the viewing client. The track is not disabled by the SDK when this event occurs. If the application wants to ensure the track will not automatically be played once the source becomes active it should call disable() when receiving this event. Then it is responsible for calling enable() on the Active event. If the application does not disable on Inactive event, the track will automatically start playing when the remote source becomes Active.

• Parameters:
  • rtsRemoteTrack: The remote track that has become inactive.

---

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

• objc/MillicastSDK/rts_remote_track.h