Skip to content

JoinStorageSessionAsViewer

Source: src/AWS/KinesisVideo/JoinStorageSessionAsViewer.ts

Runtime binding for kinesisvideo:JoinStorageSessionAsViewer (WebRTC storage data plane).

Bind this operation to a SignalingChannel inside a function runtime to get a callable that resolves the per-channel WEBRTC storage endpoint (GetSignalingChannelEndpoint) and joins the ongoing WebRTC session as a viewer, identified by clientId.

Requires the channel’s media storage to be configured (an ENABLED MediaStorageConfiguration linking the channel to a stream); without it the endpoint discovery fails with the typed SignalingEndpointUnavailable error.

// init
const joinAsViewer =
yield* AWS.KinesisVideo.JoinStorageSessionAsViewer(channel);
// runtime
yield* joinAsViewer({ clientId: "viewer-1" });