TVIVideoTrack Class Reference

Inherits from TVITrack : NSObject
Declared in TVIVideoTrack.h

Overview

TVIVideoTrack represents video, and provides an interface to render frames from the track.

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Tracks cannot be created explicitly.

Declared In

TVIVideoTrack.h

  delegate

The video track’s delegate. Set the delegate to receive updates about the track.

@property (nonatomic, weak, nullable) id<TVIVideoTrackDelegate> delegate

Declared In

TVIVideoTrack.h

  attachedViews

An array of views that are currently attached to the video track.

@property (nonatomic, strong, readonly, nonnull) NSArray<UIView*> *attachedViews

Discussion

Note: Use the ‘attach:’ and ‘detach:’ methods to manipulate this collection.

Declared In

TVIVideoTrack.h

  renderers

An array of renderers that are currently attached to the video track.

@property (nonatomic, strong, readonly, nonnull) NSArray<id<TVIVideoRenderer> > *renderers

Discussion

Note: Use the ‘addRenderer:’ and ‘removeRenderer:’ methods to manipulate this collection.

Declared In

TVIVideoTrack.h

  videoDimensions

The dimensions of the track’s video. Use this to layout attached views.

@property (nonatomic, assign, readonly) CMVideoDimensions videoDimensions

Declared In

TVIVideoTrack.h

– attach:

Attaches a view to the video track. The track’s contents will be drawn into the attached view.

- (void)attach:(nonnull UIView *)view

Parameters

view

The view to attach.

Discussion

The attach: API is the simplest way to display video. For more control see addRenderer:.

Declared In

TVIVideoTrack.h

– detach:

Detaches a view from the video track. The track’s contents will no longer be drawn into the attached view.

- (void)detach:(nonnull UIView *)view

Parameters

view

The view to detach.

Declared In

TVIVideoTrack.h

– addRenderer:

Adds a renderer to the video track. Renderers provide fine control over how video is displayed.

- (void)addRenderer:(nonnull id<TVIVideoRenderer>)renderer

Parameters

renderer

An object or swift struct that implements the TVIVideoRenderer protocol.

Discussion

Use this method instead of attach to add your own renderer to TVIVideoTrack.

Declared In

TVIVideoTrack.h

– removeRenderer:

Removes a renderer from the video track.

- (void)removeRenderer:(nonnull id<TVIVideoRenderer>)renderer

Parameters

renderer

An object or swift struct that implements the TVIVideoRenderer protocol.

Declared In

TVIVideoTrack.h