Amazon.IVSRealTime Namespace | AWS SDK for .NET V3

Classes

	Name	Description
	AmazonIVSRealTimeClient	Implementation for accessing IVSRealTime The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. Key Concepts Stage — A virtual space where participants can exchange video in real time. Participant token — A token that authenticates a participant when they join a stage. Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants. For server-side composition: Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process. Composition — Controls the look of the outputs, including how participants are positioned in the video. For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming. Tagging A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as `topic:nature` to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there. Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags). The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage. At most 50 tags can be applied to a resource.
	AmazonIVSRealTimeConfig	Configuration for accessing Amazon IVSRealTime service
	AmazonIVSRealTimeDefaultConfiguration	Configuration for accessing Amazon IVSRealTime service
	AmazonIVSRealTimeException	Common exception for the IVSRealTime service.
	AmazonIVSRealTimeRequest	Base class for IVSRealTime operation requests.
	CompositionState	Constants used for properties of type CompositionState.
	DestinationState	Constants used for properties of type DestinationState.
	EventErrorCode	Constants used for properties of type EventErrorCode.
	EventName	Constants used for properties of type EventName.
	IngestConfigurationState	Constants used for properties of type IngestConfigurationState.
	IngestProtocol	Constants used for properties of type IngestProtocol.
	ParticipantProtocol	Constants used for properties of type ParticipantProtocol.
	ParticipantRecordingFilterByRecordingState	Constants used for properties of type ParticipantRecordingFilterByRecordingState.
	ParticipantRecordingMediaType	Constants used for properties of type ParticipantRecordingMediaType.
	ParticipantRecordingState	Constants used for properties of type ParticipantRecordingState.
	ParticipantState	Constants used for properties of type ParticipantState.
	ParticipantTokenCapability	Constants used for properties of type ParticipantTokenCapability.
	PipBehavior	Constants used for properties of type PipBehavior.
	PipPosition	Constants used for properties of type PipPosition.
	RecordingConfigurationFormat	Constants used for properties of type RecordingConfigurationFormat.
	ThumbnailRecordingMode	Constants used for properties of type ThumbnailRecordingMode.
	ThumbnailStorageType	Constants used for properties of type ThumbnailStorageType.
	VideoAspectRatio	Constants used for properties of type VideoAspectRatio.
	VideoFillMode	Constants used for properties of type VideoFillMode.

Interfaces

Name Description

	Name	Description
	IAmazonIVSRealTime	Interface for accessing IVSRealTime The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. Key Concepts Stage — A virtual space where participants can exchange video in real time. Participant token — A token that authenticates a participant when they join a stage. Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants. For server-side composition: Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process. Composition — Controls the look of the outputs, including how participants are positioned in the video. For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming. Tagging A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as `topic:nature` to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there. Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags). The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage. At most 50 tags can be applied to a resource.

IAmazonIVSRealTime

Interface for accessing IVSRealTime

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

Key Concepts

Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.

For server-side composition:

Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.