ivsrealtime/aws.sdk.kotlin.services.ivsrealtime

Package-level declarations

Types

Link copied to clipboard
interface IvsRealTimeClient : SdkClient

Introduction

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun IvsRealTimeClient.createEncoderConfiguration(crossinline block: CreateEncoderConfigurationRequest.Builder.() -> Unit): CreateEncoderConfigurationResponse

Creates an EncoderConfiguration object.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.createParticipantToken(crossinline block: CreateParticipantTokenRequest.Builder.() -> Unit): CreateParticipantTokenResponse

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.createStage(crossinline block: CreateStageRequest.Builder.() -> Unit): CreateStageResponse

Creates a new stage (and optionally participant tokens).

Link copied to clipboard
inline suspend fun IvsRealTimeClient.createStorageConfiguration(crossinline block: CreateStorageConfigurationRequest.Builder.() -> Unit): CreateStorageConfigurationResponse

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.deleteEncoderConfiguration(crossinline block: DeleteEncoderConfigurationRequest.Builder.() -> Unit): DeleteEncoderConfigurationResponse

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.deleteStage(crossinline block: DeleteStageRequest.Builder.() -> Unit): DeleteStageResponse

Shuts down and deletes the specified stage (disconnecting all participants).

Link copied to clipboard
inline suspend fun IvsRealTimeClient.deleteStorageConfiguration(crossinline block: DeleteStorageConfigurationRequest.Builder.() -> Unit): DeleteStorageConfigurationResponse

Deletes the storage configuration for the specified ARN.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.disconnectParticipant(crossinline block: DisconnectParticipantRequest.Builder.() -> Unit): DisconnectParticipantResponse

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.getComposition(crossinline block: GetCompositionRequest.Builder.() -> Unit): GetCompositionResponse

Get information about the specified Composition resource.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.getEncoderConfiguration(crossinline block: GetEncoderConfigurationRequest.Builder.() -> Unit): GetEncoderConfigurationResponse

Gets information about the specified EncoderConfiguration resource.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.getParticipant(crossinline block: GetParticipantRequest.Builder.() -> Unit): GetParticipantResponse

Gets information about the specified participant token.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.getStage(crossinline block: GetStageRequest.Builder.() -> Unit): GetStageResponse

Gets information for the specified stage.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.getStageSession(crossinline block: GetStageSessionRequest.Builder.() -> Unit): GetStageSessionResponse

Gets information for the specified stage session.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.getStorageConfiguration(crossinline block: GetStorageConfigurationRequest.Builder.() -> Unit): GetStorageConfigurationResponse

Gets the storage configuration for the specified ARN.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listCompositions(crossinline block: ListCompositionsRequest.Builder.() -> Unit): ListCompositionsResponse

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listEncoderConfigurations(crossinline block: ListEncoderConfigurationsRequest.Builder.() -> Unit): ListEncoderConfigurationsResponse

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listParticipantEvents(crossinline block: ListParticipantEventsRequest.Builder.() -> Unit): ListParticipantEventsResponse

Lists events for a specified participant that occurred during a specified stage session.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listParticipants(crossinline block: ListParticipantsRequest.Builder.() -> Unit): ListParticipantsResponse

Lists all participants in a specified stage session.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listStages(crossinline block: ListStagesRequest.Builder.() -> Unit): ListStagesResponse

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listStageSessions(crossinline block: ListStageSessionsRequest.Builder.() -> Unit): ListStageSessionsResponse

Gets all sessions for a specified stage.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listStorageConfigurations(crossinline block: ListStorageConfigurationsRequest.Builder.() -> Unit): ListStorageConfigurationsResponse

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Gets information about AWS tags for the specified ARN.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.startComposition(crossinline block: StartCompositionRequest.Builder.() -> Unit): StartCompositionResponse

Starts a Composition from a stage based on the configuration provided in the request.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.stopComposition(crossinline block: StopCompositionRequest.Builder.() -> Unit): StopCompositionResponse

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or updates tags for the AWS resource with the specified ARN.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the resource with the specified ARN.

Link copied to clipboard
inline suspend fun IvsRealTimeClient.updateStage(crossinline block: UpdateStageRequest.Builder.() -> Unit): UpdateStageResponse

Updates a stage’s configuration.

Link copied to clipboard
fun IvsRealTimeClient.withConfig(block: IvsRealTimeClient.Config.Builder.() -> Unit): IvsRealTimeClient

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.