Interface KinesisVideoWebRtcStorageClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface KinesisVideoWebRtcStorageClient extends AwsClient
Service client for accessing Amazon Kinesis Video WebRTC Storage. This can be created using the static builder() method.

webrtc

  • Field Details

  • Method Details

    • joinStorageSession

      default JoinStorageSessionResponse joinStorageSession(JoinStorageSessionRequest joinStorageSessionRequest) throws ClientLimitExceededException, InvalidArgumentException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisVideoWebRtcStorageException

      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.

      Both audio and video tracks are currently required for WebRTC ingestion.

      Current requirements:

      • Video track: H.264

      • Audio track: Opus

      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.

      S3 image delivery and notifications are not currently supported.

      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.

      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.

      Parameters:
      joinStorageSessionRequest -
      Returns:
      Result of the JoinStorageSession operation returned by the service.
      See Also:

    • joinStorageSession

      default JoinStorageSessionResponse joinStorageSession(Consumer<JoinStorageSessionRequest.Builder> joinStorageSessionRequest) throws ClientLimitExceededException, InvalidArgumentException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisVideoWebRtcStorageException

      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.

      Both audio and video tracks are currently required for WebRTC ingestion.

      Current requirements:

      • Video track: H.264

      • Audio track: Opus

      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.

      S3 image delivery and notifications are not currently supported.

      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.

      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.


      This is a convenience which creates an instance of the JoinStorageSessionRequest.Builder avoiding the need to create one manually via JoinStorageSessionRequest.builder()

      Parameters:
      joinStorageSessionRequest - A Consumer that will call methods on JoinStorageSessionRequest.Builder to create a request.
      Returns:
      Result of the JoinStorageSession operation returned by the service.
      See Also:

    • joinStorageSessionAsViewer

      default JoinStorageSessionAsViewerResponse joinStorageSessionAsViewer(JoinStorageSessionAsViewerRequest joinStorageSessionAsViewerRequest) throws ClientLimitExceededException, InvalidArgumentException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisVideoWebRtcStorageException

      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.

      Parameters:
      joinStorageSessionAsViewerRequest -
      Returns:
      Result of the JoinStorageSessionAsViewer operation returned by the service.
      See Also:

    • joinStorageSessionAsViewer

      default JoinStorageSessionAsViewerResponse joinStorageSessionAsViewer(Consumer<JoinStorageSessionAsViewerRequest.Builder> joinStorageSessionAsViewerRequest) throws ClientLimitExceededException, InvalidArgumentException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisVideoWebRtcStorageException

      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.


      This is a convenience which creates an instance of the JoinStorageSessionAsViewerRequest.Builder avoiding the need to create one manually via JoinStorageSessionAsViewerRequest.builder()

      Parameters:
      joinStorageSessionAsViewerRequest - A Consumer that will call methods on JoinStorageSessionAsViewerRequest.Builder to create a request.
      Returns:
      Result of the JoinStorageSessionAsViewer operation returned by the service.
      See Also:

    • create

      static KinesisVideoWebRtcStorageClient create()
      Create a KinesisVideoWebRtcStorageClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static KinesisVideoWebRtcStorageClientBuilder builder()
      Create a builder that can be used to configure and create a KinesisVideoWebRtcStorageClient.

    • serviceMetadata

      static ServiceMetadata serviceMetadata()

    • serviceClientConfiguration

      default KinesisVideoWebRtcStorageServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration