MillicastSDK 2.0.0
Loading...
Searching...
No Matches
Instance Methods | List of all members
MCRTSRemoteVideoTrack Class Reference

The RTS logical track's video interface. More...

#import <rts_remote_track.h>

Inheritance diagram for MCRTSRemoteVideoTrack:
Inheritance graph
[legend]
Collaboration diagram for MCRTSRemoteVideoTrack:
Collaboration graph
[legend]

Instance Methods

(instancetype _Nonnull) - NS_UNAVAILABLE
 
(void) - enableWithRenderer:layer:promote:completionHandler:
 
(void) - enableWithRenderer:promote:completionHandler:
 
(void) - enableWithRenderer:layer:completionHandler:
 
(void) - enableWithRenderer:completionHandler:
 
 __rtsRemoteVideoTrack
 
 initWithNativeTrack:
 
- Instance Methods inherited from MCRTSRemoteTrack
(MCRTSRemoteVideoTrack *_Nullable) - asVideo
 
(MCRTSRemoteAudioTrack *_Nullable) - asAudio
 
(instancetype _Nonnull) - NS_UNAVAILABLE
 
(void) - disableWithCompletionHandler:
 
 rtsRemoteTrackWithNativeTrack:
 

Additional Inherited Members

- Properties inherited from MCRTSRemoteTrack
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's video interface.

Method Documentation

◆ enableWithRenderer:completionHandler:

- (void) enableWithRenderer: (id< MCVideoRenderer > _Nonnull)  renderer
completionHandler: (enable(renderer:completionHandler:))  NS_SWIFT_NAME 

Enable the track with default promote and layer behavour.

  • Parameters:
    • renderer: The renderer to receive video frames.
    • completionHandler: Invoked when the asynchronous operation completes.

◆ enableWithRenderer:layer:completionHandler:

- (void) enableWithRenderer: (id< MCVideoRenderer > _Nonnull)  renderer
layer: (MCRTSRemoteVideoTrackLayer *_Nonnull)  layer
completionHandler: (enable(renderer:layer:completionHandler:))  NS_SWIFT_NAME 

Enable the track with default promote behavour, which is false.

  • Parameters:
    • renderer: The renderer to receive video frames.
    • promote: set this track to be the main video track. The main video track has highest priority for bandwidth assignment when SVC layers are managed by the service.
    • completionHandler: Invoked when the asynchronous operation completes.

◆ enableWithRenderer:layer:promote:completionHandler:

- (void) enableWithRenderer: (id< MCVideoRenderer > _Nonnull)  renderer
layer: (MCRTSRemoteVideoTrackLayer *_Nonnull)  layer
promote: (BOOL)  promote
completionHandler: (enable(renderer:layer:promote:completionHandler:))  NS_SWIFT_NAME 

Enable the track with a renderer to start receiving media. You can choose from MCAcceleratedVideoRenderer or MCCMSampleBufferVideoRenderer which are directly attachable to Views. Otherwise, if you have a specific usecase for receiving video frames and managing them yourself, then you can implement your own MCVideoRenderer

  • Parameters:
    • renderer: The renderer to receive video frames.
    • layer: Layer information. If the default value is passed, the service will allocate layers automatically depending on bandwidth estimation and the priority
    • promote: set this track to be the main video track. The main video track has highest priority for bandwidth assignment when SVC layers are managed by the service.
    • completionHandler: Invoked when the asynchronous operation completes.

◆ enableWithRenderer:promote:completionHandler:

- (void) enableWithRenderer: (id< MCVideoRenderer > _Nonnull)  renderer
promote: (BOOL)  promote
completionHandler: (enable(renderer:promote:completionHandler:))  NS_SWIFT_NAME 

Enable the track with default layer behaviour

  • Parameters:
    • renderer: The renderer to receive video frames.
    • promote: set this track to be the main video track. The main video track has highest priority for bandwidth assignment when SVC layers are managed by the service.
    • completionHandler: Invoked when the asynchronous operation completes.

◆ NS_UNAVAILABLE

- (instancetype _Nonnull) NS_UNAVAILABLE

Implements MCRTSRemoteTrack.


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