IVSRealTime

import { IVSRealTime } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/ivsrealtime.ts?docs=full";

class IVSRealTime {

constructor(apiFactory: client.ApiFactory);

async createEncoderConfiguration(params?: CreateEncoderConfigurationRequest, opts?: client.RequestOptions): Promise<CreateEncoderConfigurationResponse>;

async createParticipantToken(params: CreateParticipantTokenRequest, opts?: client.RequestOptions): Promise<CreateParticipantTokenResponse>;

async createStage(params?: CreateStageRequest, opts?: client.RequestOptions): Promise<CreateStageResponse>;

async createStorageConfiguration(params: CreateStorageConfigurationRequest, opts?: client.RequestOptions): Promise<CreateStorageConfigurationResponse>;

async deleteEncoderConfiguration(params: DeleteEncoderConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async deletePublicKey(params: DeletePublicKeyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>;

async deleteStorageConfiguration(params: DeleteStorageConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async disconnectParticipant(params: DisconnectParticipantRequest, opts?: client.RequestOptions): Promise<void>;

async getComposition(params: GetCompositionRequest, opts?: client.RequestOptions): Promise<GetCompositionResponse>;

async getEncoderConfiguration(params: GetEncoderConfigurationRequest, opts?: client.RequestOptions): Promise<GetEncoderConfigurationResponse>;

async getParticipant(params: GetParticipantRequest, opts?: client.RequestOptions): Promise<GetParticipantResponse>;

async getPublicKey(params: GetPublicKeyRequest, opts?: client.RequestOptions): Promise<GetPublicKeyResponse>;

async getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<GetStageResponse>;

async getStageSession(params: GetStageSessionRequest, opts?: client.RequestOptions): Promise<GetStageSessionResponse>;

async getStorageConfiguration(params: GetStorageConfigurationRequest, opts?: client.RequestOptions): Promise<GetStorageConfigurationResponse>;

async importPublicKey(params: ImportPublicKeyRequest, opts?: client.RequestOptions): Promise<ImportPublicKeyResponse>;

async listCompositions(params?: ListCompositionsRequest, opts?: client.RequestOptions): Promise<ListCompositionsResponse>;

async listEncoderConfigurations(params?: ListEncoderConfigurationsRequest, opts?: client.RequestOptions): Promise<ListEncoderConfigurationsResponse>;

async listParticipantEvents(params: ListParticipantEventsRequest, opts?: client.RequestOptions): Promise<ListParticipantEventsResponse>;

async listParticipants(params: ListParticipantsRequest, opts?: client.RequestOptions): Promise<ListParticipantsResponse>;

async listPublicKeys(params?: ListPublicKeysRequest, opts?: client.RequestOptions): Promise<ListPublicKeysResponse>;

async listStages(params?: ListStagesRequest, opts?: client.RequestOptions): Promise<ListStagesResponse>;

async listStageSessions(params: ListStageSessionsRequest, opts?: client.RequestOptions): Promise<ListStageSessionsResponse>;

async listStorageConfigurations(params?: ListStorageConfigurationsRequest, opts?: client.RequestOptions): Promise<ListStorageConfigurationsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async startComposition(params: StartCompositionRequest, opts?: client.RequestOptions): Promise<StartCompositionResponse>;

async stopComposition(params: StopCompositionRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<UpdateStageResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new IVSRealTime(apiFactory: client.ApiFactory)

[src]

§Methods

createEncoderConfiguration(params?: CreateEncoderConfigurationRequest, opts?: client.RequestOptions): Promise<CreateEncoderConfigurationResponse>

[src]

Creates an EncoderConfiguration object.

createParticipantToken(params: CreateParticipantTokenRequest, opts?: client.RequestOptions): Promise<CreateParticipantTokenResponse>

[src]

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.

Encryption keys are owned by Amazon IVS and never used directly by your application.

createStage(params?: CreateStageRequest, opts?: client.RequestOptions): Promise<CreateStageResponse>

[src]

Creates a new stage (and optionally participant tokens).

createStorageConfiguration(params: CreateStorageConfigurationRequest, opts?: client.RequestOptions): Promise<CreateStorageConfigurationResponse>

[src]

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.

deleteEncoderConfiguration(params: DeleteEncoderConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deletePublicKey(params: DeletePublicKeyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

deleteStage(params: DeleteStageRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteStorageConfiguration(params: DeleteStorageConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the storage configuration for the specified ARN.

If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use "StopComposition" and wait for it to complete, then use DeleteStorageConfiguration.

disconnectParticipant(params: DisconnectParticipantRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

getComposition(params: GetCompositionRequest, opts?: client.RequestOptions): Promise<GetCompositionResponse>

[src]

Get information about the specified Composition resource.

getEncoderConfiguration(params: GetEncoderConfigurationRequest, opts?: client.RequestOptions): Promise<GetEncoderConfigurationResponse>

[src]

Gets information about the specified EncoderConfiguration resource.

getParticipant(params: GetParticipantRequest, opts?: client.RequestOptions): Promise<GetParticipantResponse>

[src]

Gets information about the specified participant token.

getPublicKey(params: GetPublicKeyRequest, opts?: client.RequestOptions): Promise<GetPublicKeyResponse>

[src]

Gets information for the specified public key.

getStage(params: GetStageRequest, opts?: client.RequestOptions): Promise<GetStageResponse>

[src]

Gets information for the specified stage.

getStageSession(params: GetStageSessionRequest, opts?: client.RequestOptions): Promise<GetStageSessionResponse>

[src]

Gets information for the specified stage session.

getStorageConfiguration(params: GetStorageConfigurationRequest, opts?: client.RequestOptions): Promise<GetStorageConfigurationResponse>

[src]

Gets the storage configuration for the specified ARN.

importPublicKey(params: ImportPublicKeyRequest, opts?: client.RequestOptions): Promise<ImportPublicKeyResponse>

[src]

Import a public key to be used for signing stage participant tokens.

listCompositions(params?: ListCompositionsRequest, opts?: client.RequestOptions): Promise<ListCompositionsResponse>

[src]

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

listEncoderConfigurations(params?: ListEncoderConfigurationsRequest, opts?: client.RequestOptions): Promise<ListEncoderConfigurationsResponse>

[src]

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

listParticipantEvents(params: ListParticipantEventsRequest, opts?: client.RequestOptions): Promise<ListParticipantEventsResponse>

[src]

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

listParticipants(params: ListParticipantsRequest, opts?: client.RequestOptions): Promise<ListParticipantsResponse>

[src]

Lists all participants in a specified stage session.

listPublicKeys(params?: ListPublicKeysRequest, opts?: client.RequestOptions): Promise<ListPublicKeysResponse>

[src]

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

listStages(params?: ListStagesRequest, opts?: client.RequestOptions): Promise<ListStagesResponse>

[src]

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

listStageSessions(params: ListStageSessionsRequest, opts?: client.RequestOptions): Promise<ListStageSessionsResponse>

[src]

Gets all sessions for a specified stage.

listStorageConfigurations(params?: ListStorageConfigurationsRequest, opts?: client.RequestOptions): Promise<ListStorageConfigurationsResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Gets information about AWS tags for the specified ARN.

startComposition(params: StartCompositionRequest, opts?: client.RequestOptions): Promise<StartCompositionResponse>

[src]

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

A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted:

When "StopComposition" is called.
After a 1-minute timeout, when all participants are disconnected from the stage.
After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
When broadcasting to the IVS channel fails and all retries are exhausted.
When broadcasting is disconnected and all attempts to reconnect are exhausted.

stopComposition(params: StopCompositionRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from the resource with the specified ARN.

updateStage(params: UpdateStageRequest, opts?: client.RequestOptions): Promise<UpdateStageResponse>

[src]

Updates a stage’s configuration.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]