Class: Aws::KinesisVideoWebRTCStorage::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KinesisVideoWebRTCStorage::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kinesisvideowebrtcstorage/lib/aws-sdk-kinesisvideowebrtcstorage/client.rb
Overview
An API client for KinesisVideoWebRTCStorage. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::KinesisVideoWebRTCStorage::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#join_storage_session(params = {}) ⇒ Struct
Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
365 366 367 |
# File 'gems/aws-sdk-kinesisvideowebrtcstorage/lib/aws-sdk-kinesisvideowebrtcstorage/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#join_storage_session(params = {}) ⇒ Struct
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.
412 413 414 415 |
# File 'gems/aws-sdk-kinesisvideowebrtcstorage/lib/aws-sdk-kinesisvideowebrtcstorage/client.rb', line 412 def join_storage_session(params = {}, = {}) req = build_request(:join_storage_session, params) req.send_request() end |