Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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, while viewers can only ingest audio. Both a video producing device and viewers can join the 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.

Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence.

Synopsis

data JoinStorageSession = JoinStorageSession' {
- channelArn :: Text
}
newJoinStorageSession :: Text -> JoinStorageSession
joinStorageSession_channelArn :: Lens' JoinStorageSession Text
data JoinStorageSessionResponse = JoinStorageSessionResponse' {
}
newJoinStorageSessionResponse :: JoinStorageSessionResponse

Creating a Request

data JoinStorageSession Source #

See: newJoinStorageSession smart constructor.

Constructors

JoinStorageSession'
Fields channelArn :: Text The Amazon Resource Name (ARN) of the signaling channel.

Instances

Instances details

ToJSON JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods toJSON :: JoinStorageSession -> Value # toEncoding :: JoinStorageSession -> Encoding # toJSONList :: [JoinStorageSession] -> Value # toEncodingList :: [JoinStorageSession] -> Encoding #
ToHeaders JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods toHeaders :: JoinStorageSession -> [Header] #
ToPath JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods toPath :: JoinStorageSession -> ByteString #
ToQuery JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods toQuery :: JoinStorageSession -> QueryString #
AWSRequest JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Associated Types type AWSResponse JoinStorageSession # Methods request :: (Service -> Service) -> JoinStorageSession -> Request JoinStorageSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy JoinStorageSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse JoinStorageSession))) #
Generic JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Associated Types type Rep JoinStorageSession :: Type -> Type # Methods from :: JoinStorageSession -> Rep JoinStorageSession x # to :: Rep JoinStorageSession x -> JoinStorageSession #
Read JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods readsPrec :: Int -> ReadS JoinStorageSession # readList :: ReadS [JoinStorageSession] # readPrec :: ReadPrec JoinStorageSession # readListPrec :: ReadPrec [JoinStorageSession] #
Show JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods showsPrec :: Int -> JoinStorageSession -> ShowS # show :: JoinStorageSession -> String # showList :: [JoinStorageSession] -> ShowS #
NFData JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods rnf :: JoinStorageSession -> () #
Eq JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods (==) :: JoinStorageSession -> JoinStorageSession -> Bool # (/=) :: JoinStorageSession -> JoinStorageSession -> Bool #
Hashable JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods hashWithSalt :: Int -> JoinStorageSession -> Int # hash :: JoinStorageSession -> Int #
type AWSResponse JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession type AWSResponse JoinStorageSession = JoinStorageSessionResponse
type Rep JoinStorageSession Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession type Rep JoinStorageSession = D1 ('MetaData "JoinStorageSession" "Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession" "amazonka-kinesis-video-webrtc-storage-2.0-2trTfwlUuKtKDDf5fOhDmv" 'False) (C1 ('MetaCons "JoinStorageSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newJoinStorageSession Source #

Arguments

:: Text	`$sel:channelArn:JoinStorageSession'`
-> JoinStorageSession

Create a value of JoinStorageSession with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:channelArn:JoinStorageSession', joinStorageSession_channelArn - The Amazon Resource Name (ARN) of the signaling channel.

Request Lenses

joinStorageSession_channelArn :: Lens' JoinStorageSession Text Source #

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

Destructuring the Response

data JoinStorageSessionResponse Source #

See: newJoinStorageSessionResponse smart constructor.

Constructors

JoinStorageSessionResponse'

Instances

Instances details

Generic JoinStorageSessionResponse Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Associated Types type Rep JoinStorageSessionResponse :: Type -> Type # Methods from :: JoinStorageSessionResponse -> Rep JoinStorageSessionResponse x # to :: Rep JoinStorageSessionResponse x -> JoinStorageSessionResponse #
Read JoinStorageSessionResponse Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods readsPrec :: Int -> ReadS JoinStorageSessionResponse # readList :: ReadS [JoinStorageSessionResponse] # readPrec :: ReadPrec JoinStorageSessionResponse # readListPrec :: ReadPrec [JoinStorageSessionResponse] #
Show JoinStorageSessionResponse Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods showsPrec :: Int -> JoinStorageSessionResponse -> ShowS # show :: JoinStorageSessionResponse -> String # showList :: [JoinStorageSessionResponse] -> ShowS #
NFData JoinStorageSessionResponse Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods rnf :: JoinStorageSessionResponse -> () #
Eq JoinStorageSessionResponse Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession Methods (==) :: JoinStorageSessionResponse -> JoinStorageSessionResponse -> Bool # (/=) :: JoinStorageSessionResponse -> JoinStorageSessionResponse -> Bool #
type Rep JoinStorageSessionResponse Source #
Instance details Defined in Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession type Rep JoinStorageSessionResponse = D1 ('MetaData "JoinStorageSessionResponse" "Amazonka.KinesisVideoWebRtcStorage.JoinStorageSession" "amazonka-kinesis-video-webrtc-storage-2.0-2trTfwlUuKtKDDf5fOhDmv" 'False) (C1 ('MetaCons "JoinStorageSessionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newJoinStorageSessionResponse :: JoinStorageSessionResponse Source #

Create a value of JoinStorageSessionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.