IVSBroadcastErrorCode

Network connection failed during initialization due to system resource constraints. Verify network availability and retry the stream.

Network connection setup failed due to configuration issues. Check network connectivity and retry the stream.

Unable to establish network connection to the streaming server. Verify network connectivity and that the stream URL is accessible.

Failed to send data over the network connection. Check network stability and restart the stream.

Failed to receive data from the streaming server. Check network stability and restart the stream.

The streaming server closed the connection unexpectedly. Verify no other users are streaming to this endpoint and restart the stream.

Network connection closed unexpectedly during stream playback. Check network stability and restart the stream.

Network error occurred during stream playback. Verify network connectivity and restart the stream.

Network latency measurement is unavailable on this device. Streaming will continue without latency metrics.

Network send buffer configuration failed. Check network conditions and retry the stream.

Unable to resolve the streaming server hostname. Check network connectivity and verify the stream URL is correct.

Network metrics calculation failed due to invalid configuration. This is an internal error that should not affect streaming, but calculated transmission statistics may be impacted.

Network congestion measurement failed due to invalid configuration. This is an internal error that should not affect streaming, but calculated transmission statistics may be impacted.

Secure connection data transmission failed due to protocol violation. Restart the stream to re-establish the connection.

Data transmission attempted before secure connection was established. Restart the stream.

Data transmission attempted after connection was closed. Restart the stream to re-establish the connection.

Data reception attempted before secure connection was established. Restart the stream.

Data reception attempted after connection was closed. Restart the stream to re-establish the connection.

The streaming server closed the connection. Verify no other users are streaming to this endpoint and restart the stream.

Data reception attempted while connection is closing. This is expected during stream shutdown.

Secure connection initialization failed. This is usually an allocation failure, the device may not be able to allocate more memory to the process.

Failed to send data over secure connection. Check network stability and restart the stream. This could also be caused by a firewall restricting access to the provided domain.

Failed to receive data over secure connection. Check network stability and restart the stream.

Secure connection handshake failed. Verify network connectivity and restart the stream. This could also be caused by a firewall restricting access to the provided domain.

Certificate verification setup failed during secure connection. Restart the stream to retry the connection. This could also be caused by a firewall restricting access to the provided domain.

Server hostname configuration failed during secure connection setup. Verify the stream URL and restart the stream. This could also be caused by a firewall restricting access to the provided domain.

Certificate hostname verification setup failed. Verify the stream URL is correct and restart the stream. This could also be caused by a firewall restricting access to the provided domain.

Internal timing mechanism failed. This may prevent efficient DNS resolution.

Server did not accept WebSocket connection request.

WebSocket handshake validation failed.

Server selected a WebSocket protocol not supported by the client. Verify the events URL is correct and restart the session.

WebSocket connection took too long to establish. Check network connectivity and retry the connection.

Server rejected WebSocket connection with unexpected status code. Verify the events URL supports WebSocket connections.

Server response headers do not meet WebSocket protocol requirements. Verify the events URL is correct and supports WebSocket.

Received malformed data from the streaming server. Restart the session to re-establish the connection.

Received data with invalid length from the streaming server. Restart the connection to re-establish the connection.

Server violated WebSocket protocol by sending masked data. Restart the session to re-establish the connection.

Server sent control message exceeding protocol limit. Restart the session to re-establish the connection.

Received text message with invalid character encoding from the server. Restart the session to re-establish the connection.

Server violated WebSocket protocol by setting reserved bits. Restart the session to re-establish the connection.

Received partial data from the streaming server. This is typically handled automatically by waiting for more data and should not impact the session.

Server violated WebSocket protocol by fragmenting a control message. Restart the session to re-establish the connection.

Received message exceeds maximum allowed size. Restart the session to re-establish the connection.

Attempted to send data before WebSocket connection was ready. This is an internal SDK and the session should be retried.

WebSocket connection took too long to establish. Check network connectivity and restart the session.

The streaming server closed the WebSocket connection. Check network connectivity and restart the session.

Server did not acknowledge connection close request in time. The connection will be terminated forcefully.

The client sent a WebSocket PING on the idle WebSocket but no PONG was received within the timeout period. It is likely the socket has disconnected but hasn’t yet reached the TCP idle timeout. The WebSocket will automatically attempt to reconnect.

The streaming server rejected the connection or encountered an error. Check your stream key and server configuration, then retry.

Timed metadata payload exceeds the 10KB limit. Reduce the metadata size to stay within the allowed limit.

Cannot start broadcast when already started. Stop the current broadcast and create a new BroadcastSession before starting a new stream.

Received data from server in an unexpected state. This indicates a protocol error; restart the broadcast session.

The streaming server is using an incompatible RTMP version. Verify the server configuration and ensure it supports standard RTMP.

Received invalid data from the streaming server. Verify the server URL is correct and supports RTMP streaming.

Server sent data before establishing the stream. This indicates a protocol error; restart the broadcast session.

Server sent control message on wrong stream. This indicates a protocol error; restart the broadcast session.

Server sent malformed chunk size message. This indicates a protocol error; restart the broadcast session.

Server requested invalid chunk size (must be 1-16777215 bytes). This indicates a protocol error; restart the broadcast session.

Server sent malformed abort message. This indicates a protocol error; restart the broadcast session.

Server sent abort message with invalid stream ID. This indicates a protocol error; restart the broadcast session.

Server tried to abort a stream that was never initialized. This indicates a protocol error; restart the broadcast session.

Server sent malformed acknowledgement message. This indicates a protocol error; restart the broadcast session.

Server sent malformed window acknowledgement size message. This indicates a protocol error; restart the broadcast session.

Server sent malformed bandwidth control message. This indicates a protocol error; restart the broadcast session.

Server sent malformed user control message. This indicates a protocol error; restart the broadcast session.

Server sent malformed ping request. This indicates a protocol error; restart the broadcast session.

Server sent message exceeding maximum allowed size. This indicates a protocol error; restart the broadcast session.

Audio mixer received empty audio buffer. Ensure audio sources are providing valid data before mixing.

Session must be configured before starting a broadcast. Call setup() before attempting to start streaming.

Operation requires an active broadcast connection. Start streaming before calling this method.

Cannot start a new broadcast while already streaming or running a network test. Stop the current session first.

Metadata payload exceeds the 10KB limit. Reduce the metadata size before sending.

Streaming URL or key exceeds the 64KB limit. Verify the endpoint and stream key are valid.

Streaming URL uses an unsupported protocol. Use rtmp:// or rtmps:// schemes.

Cannot add a slot with a duplicate name. Use a unique name or remove the existing slot first.

Cannot remove a slot that doesn’t exist. Verify the slot name is correct.

Video sample was ignored because no slot is bound to receive it. This is informational and typically expected behavior.

Network bandwidth is insufficient for streaming. A stream can still be started, but it is expected to perform very poorly even at a low minimum bitrate.

Network test was canceled before completion. Start a new test if you need recommended settings.

Video keyframe is missing required codec configuration data. Possible bad encoder output, restart the BroadcastSession to recreate the encoder.

Network latency exceeded acceptable limits and the broadcast was stopped. Improve network stability or reduce bitrate.

Stream stop operation did not complete successfully. Wait 30 seconds before streaming to the same channel again.

Video pixel format is not supported by the device. Use a supported format like NV12 or RGBA.

Background image source received no valid images before finalization. Ensure images are submitted before stopping the source.

Image buffer stride value is invalid for the specified dimensions. Verify stride matches pixel format requirements.

Image buffer size is too small for the specified dimensions and format. Check that the input buffer provided is valid.

Image buffer size exceeds expected size for the specified dimensions and format. Verify buffer size calculation.

Image pixel format is not supported on this device. Use a supported format like NV12 or RGBA.

Image buffer content size did not equal width * height * bits per pixel. Check to make sure the image buffer was not corrupted.

Image buffer pixel format cannot be changed after creation. Create a new buffer with the desired format.

Image buffer is invalid or was destroyed. Verify the buffer is properly initialized before use.

Image data pointer is null or invalid. Provide valid image data before submitting.

Operation is not supported for this image buffer type. Use a compatible buffer or operation.

Codec support configuration is not yet available. Retry codec discovery after a brief delay.

Codec is disabled for this streaming channel.

HEVC codec is not supported on this device with the current configuration. Use AVC instead.

Video encoder produced frames with non-increasing timestamps. This device may not support the selected codec reliably.

Video encoder is missing required codec configuration data (SPS/PPS/VPS). This device may not support the selected codec reliably.

Video encoder is too slow or stopped responding during validation. This device may not support the selected codec or quality settings.

Video encoder produced an unexpected number of keyframes during validation. This device may not support the selected codec reliably.

Failed to establish streaming connection to the server. Check network connectivity and verify the streaming URL is correct.

Failed to start publishing the stream to the server. Verify the stream key is valid and the channel is not already streaming.

Streaming URL uses an unsupported protocol. Use rtmp:// or rtmps:// schemes.

Streaming URL is missing a valid port number and no default is available. Verify the URL format is correct.

Streaming URL contains an invalid port number. Use a port between 1 and 65535.

Audio statistics are unavailable because no audio data has been processed. Ensure audio sources are active and producing data.

Cannot embed an empty message in the video stream. Provide valid message data before calling this method.

Message data exceeds the 1KB limit for embedding in video frames. Reduce the message size to 1KB or less.

Message repeat count is outside the valid range of 0-30. Adjust the repeat count to be within this range.

Message embedding rate limit exceeded (10KB per second). Reduce message frequency or size to stay within the limit.

Video rendering failed because no output buffer was provided. Ensure a valid destination buffer is set before rendering.

Video rendering shader is missing from the SDK bundle. Verify the SDK was packaged correctly and all resources are included.

Video rendering initialization failed on this device. This indicates a device compatibility issue with Metal graphics.

Video encoder failed repeatedly and cannot recover. This device may not support the selected codec or quality settings reliably.

SSL certificate validation encountered an internal error. Check network connectivity and verify the streaming endpoint uses valid certificates.

Failed to load trusted certificate authorities for SSL validation. This indicates a system configuration issue.

SSL certificate hostname validation failed. Verify the streaming URL matches the certificate and the endpoint is correct.

SSL certificate chain is empty or invalid. Verify the streaming endpoint provides valid certificates.

SSL certificate validation failed. Verify the streaming endpoint uses valid, non-expired certificates.

Audio encoding failed during compression. The encoder will attempt to reset and continue streaming.

Failed to configure audio encoder with required settings. Verify audio configuration is supported on this device.

Failed to retrieve audio encoder configuration. The encoder may not support the requested audio format.

Failed to initialize audio encoder. Verify audio configuration matches device capabilities.

Video encoder repeatedly failed and cannot recover. Stop and restart the broadcast session.

Video frame encoding failed. The encoder has stopped and the broadcast session must be restarted.

Failed to extract encoded video data from compression buffer. The broadcast session must be restarted.

Failed to configure video encoder with required settings. Verify video configuration is supported on this device.

Failed to initialize video encoder. Verify video configuration matches device capabilities.

Failed to query video encoder capabilities. The device may not support the requested video format.

Video encoder failed to initialize for encoding. Stop and restart the broadcast session.

Unable to identify the hardware encoder in use. This is informational and does not affect streaming.

Low latency encoding mode is unavailable on this device, using standard encoder instead. Streaming will continue with slightly higher latency.

Video encoder rejected the requested bitrate setting. The encoder will use a default bitrate instead.

Failed to allocate video buffer from the buffer pool. This device may have insufficient memory or resources.

Failed to lock video buffer for processing. Check the platform error code for device-specific details.

Failed to unlock video buffer after processing. Check the platform error code for device-specific details.

Failed to initialize video buffer pool for rendering. This device may have insufficient memory or resources.

Metal rendering shaders are missing from the SDK bundle. Verify the SDK was packaged correctly and all resources are included.

Failed to create Metal texture from video buffer. If using a custom image source, ensure kCVPixelBufferMetalCompatibilityKey is set to true when creating buffers.

Video rendering initialization failed on this device. This indicates a device compatibility issue with Metal graphics.

Audio processing failed to extract audio data from the buffer. This indicates an audio format or buffer structure issue.

Stage token is invalid or malformed. Generate a new token and create a new stage session.

Stage token has expired. Generate a new token and create a new stage session.

Cannot perform operation because no active stage session exists. Join a stage before attempting this operation.

Cannot join stage because a join operation is already in progress or completed. Wait for the current operation to finish.

The Stage session is not ready due to a failure is the setup process. Check for errors during initialization, and recreate the local Stage instance.

Cannot subscribe to your own participant stream. Subscribe to other participants instead. This should not be possible using the StageStrategy.

Participant not found in the stage. This is likely because the remote participant unpublished at the same time this SDK attempted to subscribe.

Failed to publish audio/video to the stage after multiple retry attempts. Check network connectivity and retry.

Failed to subscribe to participant stream after multiple retry attempts. Check network connectivity and retry.

Failed to create WebRTC offer for publishing. Retry the publish operation.

Failed to create WebRTC offer for subscribing. Retry the subscribe operation.

Publish or subscribe operation was cancelled. This is expected when leaving or unsubscribing in the middle of an operation.

Stage has reached maximum participant capacity. Wait for a participant to leave or create a new stage.

An unexpected server error occurred. Retry the operation or contact support if the issue persists.

Stage token lacks required permissions or has been revoked. Generate a new token with appropriate permissions.

Stage authentication failed during join operation. The stage may have been deleted or is no longer available.

Input video resolution does not meet stage requirements. Increase camera resolution or adjust stage configuration.

The token provided to the exchange token API was invalid and couldn’t be parsed. Create a new token and try again.

The token provided to the exchange token API was not compatible with the existing Stage. This is likely because properties that must remain constant (jti, topic, etc) had changed.

Internal stage event system is not initialized. Restart the stage session.

Internal event generation system is not initialized. Restart the stage session.

Stage or participant resource no longer exists on the server. The stage may have been deleted or the session expired.

Disconnected from stage by the server for an unspecified reason. Rejoin the stage with a new token if needed.

Disconnected because the stage was deleted.

Disconnected because another participant joined with the same token. Use unique tokens for each participant.

Disconnected from stage by server request. Rejoin the stage with a new token if needed.

Invalid response from the server for a token exchange request. Reconnect to the Stage using the new token, or create a new token and connect again.

The token exchange request was rejected. The error comment will contain more details. A new token must be created and used to join a new SDK Stage instance.

The token exchange request timed out. Because a token exchange puts the SDK into an in between state of 2 tokens while waiting for confirmation from the backend, a timeout is enforced to prevent undefined behaviors.

Failed to connect to stage after multiple retry attempts. Check network connectivity and retry joining the stage.

Media connection lost due to network error. Check network connectivity and rejoin the stage.

Failed to establish media connection with participant. Retry the publish or subscribe operation.

Received invalid connection data from participant.

Participant disconnected unexpectedly. The participant may have left the stage or lost network connectivity.

Failed to configure video settings for the connection. Check system resources, this may have been a memory allocation failure.

Cannot request keyframe because video sender is not ready. Ensure video is being published.

Failed to configure media transceivers for the connection. This is a libWebRTC failure and may indicate the system is low on resources.

Video sender is not ready for configuration. Ensure video is being published before adjusting settings.

Video encoding parameters are not ready. Wait for the connection to fully establish before adjusting video settings.

Failed to update video encoding settings. This is a libWebRTC failure and may indicate the system is low on resources, or the provided configuration is not supported.

Connection operation failed due to invalid configuration. The error message will contain more detailed information.

Failed to initialize media connection. This is a libWebRTC failure and may indicate the system is low on resources. Restat the session to try again.

Operation failed because the requested media type is not available. Ensure audio or video is being published or subscribed before requesting RTC stats.

Media connection is taking too long to establish. This operation will be automatically retried, but this may indicate a network connectivity issue.

WebRTC connection operation failed. This operation will be automatically retried, but this may indicate a network connectivity issue.

Media connection failed to establish network path. This operation will be automatically retried, but this may indicate a network connectivity issue.

Cannot retrieve video sender configuration because sender is not initialized. Ensure video is being published.

Cannot retrieve video receiver configuration because receiver is not initialized. Ensure video is being subscribed.

Cannot perform operation because media connection is not available. Ensure publish or subscribe is active.

No audio packets are being sent through the publish connection. Check that audio input is active and not muted.

No video packets are being sent through the publish connection. Check that video samples are being submitted.

No audio packets are being received from the subscribed participant. The participant may have stopped publishing audio or network connectivity is lost.

No video packets are being received from the subscribed participant. The participant may have stopped publishing video without muting or network connectivity is lost.

Failed to set video quality layer for participant stream. This operation will be automatically retried, but this may indicate a network connectivity issue.

Video quality layer selection is being rate limited. This operation will be automatically retried after a delay.

Failed to retrieve available video quality layers for participant stream. This operation will be automatically retried, but this may indicate a network connectivity issue.

Video quality layer query is being rate limited. This operation will be automatically retried after a delay.

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 zoom factor set on an IVSCamera must be between IVSCamera.maxAvailableVideoZoomFactor and IVSCamera.maxAvailableVideoZoomFactor This error is thrown when the camera’s zoom factor is set to a value outside this range.

This error is thrown when the -[IVSCamera setVideoZoomFactor:] API is called when the AVCaptureDevice‘s configuration lock could not be taken, or when the underlying AVCaptureDevice is nil, because it could not be constructed.

Torch cannot be enabled on an IVSCamera that does not support torch or where torch is not available. This error is thrown when the camera’s torch is enabled but the camera either does not support torch or torch is not available.

This error is thrown when, after successfully enabling the torch on an IVSCamera, the torch mode for that IVSCamera unexpectedly becomes unavailable. This can happen, for example, if the OS determines the device is at risk of overheating, in which case it will deactivate the torch.

This error is thrown when attempting to change a device’s property (e.g. setting the torch or zoom factor) when the AVCaptureDevice‘s configuration lock could not be taken, or when the underlying AVCaptureDevice is nil, because it could not be constructed.

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 50k 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 50k 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.

The stage jitter buffer min delay set on the IVSJitterBufferConfiguration must be between 0 and 10k. This error is thrown when the stage jitter buffer min delay is set to a value outside this range.

An encoder that matches the associated codec and video configuration could not be found.

The configuration has been locked by the SDK to guarantee compatibility with this device and the upstream IVS channel.

The number of the stage video layers set on the IVSLocalStageStreamVideoConfiguration must be 3 or less. This error is thrown when the number of the stage video layers is set to a value outside this range.

Two layers set on the IVSLocalStageStreamVideoConfiguration must have different configuration. This error is thrown when the two layers with the same configuration is set.

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

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

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

The layer 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.

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.

This is thrown when the delegate queue for the IVSImageDevice.setOnFrameCallback is experiencing back-pressure and frames are not being released quickly enough. Make sure the code processing the frames is processing quickly enough to handle real time samples.

The message payload is empty. Provide a non-empty NSData object.

The message payload exceeds the maximum allowed size of 1KB. Reduce the payload size and try again.

The message repeat count is invalid. The repeat count must be between 0 and 30.

The message rate limit has been exceeded. The total size of message payloads within a rolling one-second window must not exceed the maximum allowed limit of 10KB.