kinesisvideowebrtcstorage/aws.sdk.kotlin.services.kinesisvideowebrtcstorage/KinesisVideoWebRtcStorageClient

KinesisVideoWebRtcStorageClient

interface KinesisVideoWebRtcStorageClient : SdkClient

webrtc

Types

class Builder : AbstractSdkClientBuilder<KinesisVideoWebRtcStorageClient.Config, KinesisVideoWebRtcStorageClient.Config.Builder, KinesisVideoWebRtcStorageClient>

Companion

object Companion : AbstractAwsSdkClientFactory<KinesisVideoWebRtcStorageClient.Config, KinesisVideoWebRtcStorageClient.Config.Builder, KinesisVideoWebRtcStorageClient, KinesisVideoWebRtcStorageClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: KinesisVideoWebRtcStorageClient.Config

KinesisVideoWebRtcStorageClient's configuration

Functions

joinStorageSession

abstract suspend fun joinStorageSession(input: JoinStorageSessionRequest): JoinStorageSessionResponse

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.

joinStorageSessionAsViewer

abstract suspend fun joinStorageSessionAsViewer(input: JoinStorageSessionAsViewerRequest): JoinStorageSessionAsViewerResponse

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).

Inherited functions

expect abstract fun close()

joinStorageSession

inline suspend fun KinesisVideoWebRtcStorageClient.joinStorageSession(crossinline block: JoinStorageSessionRequest.Builder.() -> Unit): JoinStorageSessionResponse

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.

joinStorageSessionAsViewer

inline suspend fun KinesisVideoWebRtcStorageClient.joinStorageSessionAsViewer(crossinline block: JoinStorageSessionAsViewerRequest.Builder.() -> Unit): JoinStorageSessionAsViewerResponse

withConfig

fun KinesisVideoWebRtcStorageClient.withConfig(block: KinesisVideoWebRtcStorageClient.Config.Builder.() -> Unit): KinesisVideoWebRtcStorageClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.