JoinStorageSession

$result = $client->joinStorageSession([/* ... */]);
$promise = $client->joinStorageSessionAsync([/* ... */]);

Before using this API, you must call the GetSignalingChannelEndpoint API to request the WEBRTC endpoint. You then specify the endpoint and region in your JoinStorageSession API request.

Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided.

Currently for the SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream. Only video producing devices can join the session and record media.

The resulting ingested video in the Kinesis video stream will have the following parameters: H.264 video and AAC audio.

Once a master participant has negotiated a connection through WebRTC, the ingested media session will be stored in the Kinesis video stream. Multiple viewers are then able to play back real-time media through our Playback APIs.

You can also use existing Kinesis Video Streams features like HLS or DASH playback, image generation via GetImages, and more with ingested WebRTC media.

Additional information

• 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.

Parameter Syntax

$result = $client->joinStorageSession([
    'channelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

AccessDeniedException:

You do not have required permissions to perform this operation.

ResourceNotFoundException:

The specified resource is not found.

JoinStorageSessionAsViewer

$result = $client->joinStorageSessionAsViewer([/* ... */]);
$promise = $client->joinStorageSessionAsViewerAsync([/* ... */]);

Join the ongoing one way-video and/or multi-way audio WebRTC session as a viewer for an input channel. If there’s no existing session for the channel, create a new streaming session and provide the Amazon Resource Name (ARN) of the signaling channel (channelArn) and client id (clientId).

Currently for SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join a session first and wait for other participants. While participants are having peer to peer conversations through WebRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media.

Customers can also use existing Kinesis Video Streams features like HLS or DASH playback, Image generation, and more with ingested WebRTC media. If there’s an existing session with the same clientId that's found in the join session request, the new request takes precedence.

Parameter Syntax

$result = $client->joinStorageSessionAsViewer([
    'channelArn' => '<string>', // REQUIRED
    'clientId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

AccessDeniedException:

You do not have required permissions to perform this operation.

ResourceNotFoundException:

The specified resource is not found.