Protocols

This represents an IVSDevice that provides audio samples.

An extension of IVSAudioDevice that allows for submitting CMSampleBuffers manually. This can be used to submit PCM audio directly to the SDK.

An extension of IVSAudioDevice that represents a physical microphone accessible by the host device.

A delegate that provides updates about the attached microphone.

Provide a delegate to receive status updates and errors from the SDK. Updates may be run on arbitrary threads and not the main thread.

Represents an input device such as a camera or microphone.

Represents an input device such as a camera or microphone with multiple underlying input sources.

Use this delegate to be notified about added / removed devices

An object capable of emitting errors.

Provide a delegate to receive errors emitted from IVSErrorSource objects. Updates may be run on arbitrary threads and not the main thread.

This represents an IVSDevice that provides video samples.

An extension of IVSImageDevice that allows for submitting CMSampleBuffers manually. The currently supported pixel formats are: kCVPixelFormatType_32BGRA kCVPixelFormatType_420YpCbCr8BiPlanarFullRange kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange On devices that support it, the Lossless and Lossy equivalents of these formats are also supported.

An extension of IVSCustomImageSource that is used to pre-encode an image or video to be rendered when the application goes into the background.

The timing information on the samples provided via onSampleBuffer is ignored on this image source, every image submitted will be encoded as the next frame based on the targetFramerate on the provided IVSVideoConfiguration.

Generating large numbers of samples from MP4 files is fairly straight forward using AVFoundation. There are multiple ways to do it in fact You can use AVAssetImageGenerator and generateCGImagesAsynchronously to generate an image at every 1 / FPS increment. Be certain to set requestedTimeToleranceAfter and requestedTimeToleranceBefore to .zero, otherwise it will batch the same frame multiple times.

You can also use an AVPlayer instance with AVPlayerItemVideoOutput and a DisplayLink, using the copyPixelBuffer API from the video output.

Both can provide a series of CVPixelBuffers to submit to this API in order to broadcast a looping clip while in the background.

An extension of IVSImageDevice that represents a physical camera accessible by the host device.

A delegate that provides updates about the attached camera on the main queue.

Protocol for messages parsed out of image frames.

A mixed audio device that can accept multiple audio sources to be mixed together to produce a final output. A mixed audio device with no input sources will still produce output, but the output will be silent.

This can be created through IVSDeviceDiscovery.

A mixed device is a device that can accept multiple input sources to be mixed together to produce a final output. A single IVSMixedDevice instance will be either all audio or all video sources, and the sources and configurations attached will be of the same type. A mixed device with no inputs sources will still produce output, but the output will be a a black image or silent audio, depending on the mixed device type.

A mixed device can be attached to an IVSBroadcastSession via attachDevice or to an IVSStage by wrapping it in a IVSLocalStageStream.

A mixed image device that can accept multiple image sources to be mixed together to produce a final output. A mixed image device with no input sources will still produce output, but the output will be a black image.

@warn This device will stop mixing when the application is in the background as a result of limited access to metal shaders while backgrounded.

This can be created through IVSDeviceDiscovery.

A delegate that provides information about the associated IVSRemoteStageStream.

A protocol to implement that can be used to build user interfaces. Implementing a IVSStageRenderer provides all the necessary information about a Stage to create a complete UI.

The Strategy is the decision engine associated with an IVSStage. It is how the Stage asks the host application what actions to take. If the host application wants to change their answer to a question, they can call [IVSStage refreshStrategy].

A delegate that provides information about the associated IVSStageStream.