TVIVideoSink Protocol Reference

Conforms to NSObject
Declared in TVIVideoSource.h

Overview

A source delivers video to a sink. Sources and sinks each provide requirements which must be satisfied.

  sourceRequirements required method

The source’s current requirements, delivered via onVideoFormatRequest:. A nil value indicates that the developer has made no specific request to modify the format that the source is delivering.

@property (nonatomic, copy, nullable, readonly) TVIVideoFormat *sourceRequirements

Discussion

The source’s current requirements, delivered via onVideoFormatRequest:. A nil value indicates that the developer has made no specific request to modify the format that the source is delivering.

Declared In

TVIVideoSource.h

– onVideoFrame: required method

Deliver a frame to the sink.

- (void)onVideoFrame:(nonnull TVIVideoFrame *)frame

Parameters

frame

A TVIVideoFrame to be delivered.

Discussion

Frames delivered to a TVIVideoSink will be broadcasted to attached TVIVideoRenderers, as well as any video encoders that might exist in the media engine. If cropping is required, either due to source requirements or internal sink (encoder) requirements, then the sink will add an attachment (kCVImageBufferCleanApertureKey) to the underlying CVPixelBuffer.

Declared In

TVIVideoSource.h

– onVideoFormatRequest: required method

Request that the source output in a specific format.

- (void)onVideoFormatRequest:(nullable TVIVideoFormat *)format

Parameters

format

A TVIVideoFormat object which describes the desired output format.

Discussion

Developers who are using a TVIVideoSource should call [TVIVideoSource requestOutputFormat:] instead.

Declared In

TVIVideoSource.h