IVSBroadcastError

This happens when you use the exchange devices API but the devices are of a different type, for example a microphone and a camera. Both devices must be of the same type.

This happens when trying to attach a device but the device is not found. This could happen if you query all the devices and store them in an array, a device goes offline or is unplugged, and then you attempt to connect to that device.

This happens when a device you are trying to add could not be added to as an input source.

This happens when a new output stream for the attaching device could not be added to the AVCaptureSession.

At the moment, only a single input source of each type is allowed. In the future multiple cameras may be allowed, but a single microphone will likely be a requirement for the foreseeable future.

The device being attached was unable to pair to a IVSMixerSlotConfiguration. Make sure your IVSBroadcastConfiguration has a slot with a matching preferred input device type.

The device that was submitted to attach to the IVSBroadcastSession is not supported.

When multiple external audio inputs are plugged in, only the most recently connected device can be attached to the broadcast session. The built-in microphone can always be attached.

The attaching camera does not support any of the pixel formats that the broadcast SDK supports.

Thrown when the exchange device API is called and the device being swapped out is not currently attached.

Thrown when there is an attempt to attach a device that is already attached, either through attachDevice or exchangeDevice.

RTC stats are unavailable for this stream because the stream is not currently publishing.

The audio bitrate set on the IVSBroadcastConfiguration must be between 64k and 160k. This error is thrown when the audio bitrate is set to a value outside this range.

The audio channels set on the IVSBroadcastConfiguration must be equal to 1 or 2.

The video initial bitrate set on the IVSBroadcastConfiguration must be between 100k and 8,500k. This error is thrown when the video initial bitrate is set to a value outside this range.

The video maximum bitrate set on the IVSBroadcastConfiguration must be between 100k and 8,500k. This error is thrown when the video maximum bitrate is set to a value outside this range.

The video minimum bitrate set on the IVSBroadcastConfiguration must be between 100k and 8,500k. This error is thrown when the video minimum bitrate is set to a value outside this range.

The video target framerate set on the IVSBroadcastConfiguration must be between 10 and 60. This error is thrown when the video target framerate is set to a value outside this range.

The video keyframe interval set on the IVSBroadcastConfiguration must be between 1 and 10. This error is thrown when the video keyframe interval is set to a value outside this range.

The video size set on the IVSBroadcastConfiguration must have a width and height of greater than 160, less than 1080, and the total number of pixels must be less than 2,073,600. For example, the smallest possible size is 160x160, and the biggest possible size is either 1080x1920 or 1920x1080.. This error is thrown when the video size does not meet the specified criteria.

The mixer slot name set on the IVSBroadcastConfiguration must be between 1 and 50 characetrs in length. This error is thrown when the name is shorter or longer than the requirements.

The mixer slot gain set on the IVSBroadcastConfiguration must be between 0 and 2. This error is thrown when the gain is set to a value outside this range.

The mixer slot transparency set on the IVSBroadcastConfiguration must be between 0 and 1. This error is thrown when the transparency is set to a value outside this range.

There are multiple IVSMixerSlotConfiguration objects with the same name. All names must be unique.

The stage video maximum bitrate set on the IVSLocalStageStreamVideoConfiguration must be between 100k and 2,500k. This error is thrown when the stage video maximum bitrate is set to a value outside this range.

The stage video minimum bitrate set on the IVSLocalStageStreamVideoConfiguration must be between 100k and 2,500k. This error is thrown when the stage video minimum bitrate is set to a value outside this range.

The stage video target framerate set on the IVSLocalStageStreamVideoConfiguration must be between 10 and 30. This error is thrown when the stage video target framerate is set to a value outside this range.

The stage video size set on the IVSLocalStageStreamVideoConfiguration must have a width and height of greater than 160, less than 720, and the total number of pixels must be less than 921,600. For example, the smallest possible size is 160x160, and the biggest possible size is either 720x1280 or 1280x720.. This error is thrown when the video size does not meet the specified criteria.

The stage audio bitrate set on the IVSLocalStageStreamAudioConfiguration must be between 12k and 128k. This error is thrown when the stage audio bitrate is set to a value outside this range.

When creating the preview view for a surface, there was an error obtaining the metal default library. The property “sourceError” will include the originating error.

When creating the preview view for a surface, there was an error generating the metal render pipeline state The property “sourceError” will include the originating error.

The device you’re using this on does not support Metal. Metal is a requirement for using the IVS Broadcast SDK.

This is thrown when the IVSBroadcastSession‘s isReady property is set to NO and a method is called on the session anyway.

This is thrown when an IVSCustomImageSource is used and an unsupported pixel format is provided. 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.

This is thrown when an image submitted via onSampleBuffer exceeds 32400 KB (32 bpp at 3840×2160). If you have images in resolutions greater than 4k, please convert them to format such as kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange to reduce the total size of the image below the threshold.

This is thrown when PCM data is submitted via onPCMBuffer or onSampleBuffer and the total size of the data is greater than 5.5 MB. If you run into this while submitting valid data, break up your sample into multiple smaller samples. This error will only be emitted once per audio source.

This is thrown when IVSBroadcastSession.applicationAudioSessionStrategy is set to noAction and an attempt to attach a microphone to the SDK is attempted. Microphones can still be used with the noAction strategy, but they must be managed by the host application and have their samples provided via an IVSCustomAudioSource.

This is thrown when the broadcast session is stopped due to a loss in network connectivity. You can monitor your device’s connection and start the stream again when connectivity is restored.

This API must only be called while the application is in the foreground.

An app background video source already exists. You must call removeImageSourceOnAppBackgrounded before using this API again.

The background video source is currently live. If your app responds to UIApplicationWillEnterForegroundNotification, it is possible your app will receive that notification before the broadcast SDK does. Dispatching a block to the main queue will allow the SDK to receive that notification, then the removeImageSourceOnAppBackgrounded will be safe to call.

The background video source is currently live because the attached camera is waiting to receive the AVCaptureSessionInterruptionEndedNotification notification to be fired. This is fired some time after the app returns to the foreground. Waiting for that notification and dispatching a block to the main queue that calls this API again will resolve this error if the source of the error is the attached camera. An alternative workaround would be to detach and reattach the camera.

This is thrown when the SDK’s internal state is invalid.

This is thrown when PCM data is submitted via onPCMBuffer with multiple AudioBuffer structs attached and one of the following is false All AudioBuffers have the same data length. The channels are non-interleaved (planar). The number of channels reported by the format is the same as the number of AudioBuffer structs. All of the AudioBuffers are single channel (together they can create multiple channels, but each individually must be single channel). There are only 2 AudioBuffer structs (if there are more than 2, all channels after 2 will be droppped). When this error is emitted, only a single audio channel will be processed, unless the error is too many channels, at which point 2 channels will be processed. This error will only be emitted once per audio source.

This is thrown when the host application is in the background with an active AVAudioSession, but the AVAudioSession was just interrupted. At that point the application is likely to be suspended, and any in progress sessions will be ended.

The background video source was removed before finishing.

This is thrown when the host application is in a phone call and the SDK attempts to activate the AVAudioSession. This can be safely ignored by host applications, but can be useful to track to inform end users that the SDK might not be working at the moment.

This is thrown when iOS notifies the SDK that the AVAudioSession is interrupted, and then the SDK attempts to activate the session before the interruption is ended.