SendIceCandidate - Kinesis Video Streams
RequestResponseErrorsLimits/ThrottlingIdempotentRetry behaviorConcurrent calls
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SendIceCandidate

Sends the ICE candidate to the target recipient. The prerequisite is that the client must be already connected to the WebSocket endpoint obtained from the GetSignalingChannelEndpoint API.

If the sender type is a viewer, then it sends the ICE candidate to a master. Also, it is not necessary to specify the RecipientClientId and any specified value for RecipientClientId is ignored. If the sender type is master, the ICE candidate is sent to the target specified by the RecipientClientId. RecipientClientId is a required input in this case.

A master client app is allowed to send an ICE candidate to any viewer, whereas a viewer client app is only allowed to send an ICE candidate to a master client app. If a viewer client app attempts to send an ICE candidate to another viewer client app, the request will NOT be honored.

Request

{
    "action": "ICE_CANDIDATE",
    "recipientClientId": "string",
    "messagePayload": "string",
    "correlationId": "string"
}

  • action - Type of the message that is being sent.

    • Type: ENUM

    • Valid values: SDP_OFFER, SDP_ANSWER, ICE_CANDIDATE

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: Yes

  • recipientClientId - A unique identifier for the recipient.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: No

  • messagePayload - The base64-encoded message content.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 10K.

    • Required: Yes

  • correlationId - A unique identifier for the message.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: No

Response

No response is returned if the message is successfully received by the signaling backend. If the service encounters an error and if the correlationId is specified in the request, the error details are returned as a STATUS_RESPONSE message. For more information, see Asynchronous Message Reception.

Errors

Limits/Throttling

This API is throttled at an account level if the API is invoked at too high a rate. An error returned when throttled with ClientLimitExceededException.

Idempotent

This API is not idempotent.

Retry behavior

This is counted as a new API call.

Concurrent calls

Concurrent calls are allowed. An offer is sent once per each call.