JOINSTORAGESESSIONASVIEWER()`¶

About JoinStorageSessionAsViewer¶

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.

Method Signature¶

METHODS /AWS1/IF_KNR~JOINSTORAGESESSIONASVIEWER
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/KNRCHANNELARN OPTIONAL
    !IV_CLIENTID TYPE /AWS1/KNRCLIENTID OPTIONAL
  RAISING
    /AWS1/CX_KNRACCESSDENIEDEX
    /AWS1/CX_KNRCLIENTLIMITEXCDEX
    /AWS1/CX_KNRINVALIDARGUMENTEX
    /AWS1/CX_KNRRESOURCENOTFOUNDEX
    /AWS1/CX_KNRCLIENTEXC
    /AWS1/CX_KNRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_channelarn` `TYPE /AWS1/KNRCHANNELARN` `/AWS1/KNRCHANNELARN`¶

The Amazon Resource Name (ARN) of the signaling channel.

`iv_clientid` `TYPE /AWS1/KNRCLIENTID` `/AWS1/KNRCLIENTID`¶

The unique identifier for the sender client.

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->joinstoragesessionasviewer(
  iv_channelarn = |string|
  iv_clientid = |string|
).

/AWS1/IF_KNR=>JOINSTORAGESESSIONASVIEWER()¶