# Packages
Package ivsrealtimeiface provides an interface to enable mocking the Amazon Interactive Video Service RealTime service client for testing your code.
# Functions
CompositionState_Values returns all elements of the CompositionState enum.
DestinationState_Values returns all elements of the DestinationState enum.
EventErrorCode_Values returns all elements of the EventErrorCode enum.
EventName_Values returns all elements of the EventName enum.
New creates a new instance of the IVSRealTime client with a session.
ParticipantRecordingFilterByRecordingState_Values returns all elements of the ParticipantRecordingFilterByRecordingState enum.
ParticipantRecordingMediaType_Values returns all elements of the ParticipantRecordingMediaType enum.
ParticipantRecordingState_Values returns all elements of the ParticipantRecordingState enum.
ParticipantState_Values returns all elements of the ParticipantState enum.
ParticipantTokenCapability_Values returns all elements of the ParticipantTokenCapability enum.
PipBehavior_Values returns all elements of the PipBehavior enum.
PipPosition_Values returns all elements of the PipPosition enum.
RecordingConfigurationFormat_Values returns all elements of the RecordingConfigurationFormat enum.
VideoAspectRatio_Values returns all elements of the VideoAspectRatio enum.
VideoFillMode_Values returns all elements of the VideoFillMode enum.
# Constants
CompositionStateActive is a CompositionState enum value.
CompositionStateFailed is a CompositionState enum value.
CompositionStateStarting is a CompositionState enum value.
CompositionStateStopped is a CompositionState enum value.
CompositionStateStopping is a CompositionState enum value.
DestinationStateActive is a DestinationState enum value.
DestinationStateFailed is a DestinationState enum value.
DestinationStateReconnecting is a DestinationState enum value.
DestinationStateStarting is a DestinationState enum value.
DestinationStateStopped is a DestinationState enum value.
DestinationStateStopping is a DestinationState enum value.
ID to lookup a service endpoint with.
ErrCodeAccessDeniedException for service response error code "AccessDeniedException".
ErrCodeConflictException for service response error code "ConflictException".
ErrCodeInternalServerException for service response error code "InternalServerException".
ErrCodePendingVerification for service response error code "PendingVerification".
ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".
ErrCodeServiceQuotaExceededException for service response error code "ServiceQuotaExceededException".
ErrCodeValidationException for service response error code "ValidationException".
EventErrorCodeInsufficientCapabilities is a EventErrorCode enum value.
EventErrorCodePublisherNotFound is a EventErrorCode enum value.
EventErrorCodeQuotaExceeded is a EventErrorCode enum value.
EventNameJoined is a EventName enum value.
EventNameJoinError is a EventName enum value.
EventNameLeft is a EventName enum value.
EventNamePublishError is a EventName enum value.
EventNamePublishStarted is a EventName enum value.
EventNamePublishStopped is a EventName enum value.
EventNameSubscribeError is a EventName enum value.
EventNameSubscribeStarted is a EventName enum value.
EventNameSubscribeStopped is a EventName enum value.
ParticipantRecordingFilterByRecordingStateActive is a ParticipantRecordingFilterByRecordingState enum value.
ParticipantRecordingFilterByRecordingStateFailed is a ParticipantRecordingFilterByRecordingState enum value.
ParticipantRecordingFilterByRecordingStateStarting is a ParticipantRecordingFilterByRecordingState enum value.
ParticipantRecordingFilterByRecordingStateStopped is a ParticipantRecordingFilterByRecordingState enum value.
ParticipantRecordingFilterByRecordingStateStopping is a ParticipantRecordingFilterByRecordingState enum value.
ParticipantRecordingMediaTypeAudioOnly is a ParticipantRecordingMediaType enum value.
ParticipantRecordingMediaTypeAudioVideo is a ParticipantRecordingMediaType enum value.
ParticipantRecordingStateActive is a ParticipantRecordingState enum value.
ParticipantRecordingStateDisabled is a ParticipantRecordingState enum value.
ParticipantRecordingStateFailed is a ParticipantRecordingState enum value.
ParticipantRecordingStateStarting is a ParticipantRecordingState enum value.
ParticipantRecordingStateStopped is a ParticipantRecordingState enum value.
ParticipantRecordingStateStopping is a ParticipantRecordingState enum value.
ParticipantStateConnected is a ParticipantState enum value.
ParticipantStateDisconnected is a ParticipantState enum value.
ParticipantTokenCapabilityPublish is a ParticipantTokenCapability enum value.
ParticipantTokenCapabilitySubscribe is a ParticipantTokenCapability enum value.
PipBehaviorDynamic is a PipBehavior enum value.
PipBehaviorStatic is a PipBehavior enum value.
PipPositionBottomLeft is a PipPosition enum value.
PipPositionBottomRight is a PipPosition enum value.
PipPositionTopLeft is a PipPosition enum value.
PipPositionTopRight is a PipPosition enum value.
RecordingConfigurationFormatHls is a RecordingConfigurationFormat enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
VideoAspectRatioAuto is a VideoAspectRatio enum value.
VideoAspectRatioPortrait is a VideoAspectRatio enum value.
VideoAspectRatioSquare is a VideoAspectRatio enum value.
VideoAspectRatioVideo is a VideoAspectRatio enum value.
VideoFillModeContain is a VideoFillMode enum value.
VideoFillModeCover is a VideoFillMode enum value.
VideoFillModeFill is a VideoFillMode enum value.
# Structs
Object specifying a configuration for individual participant recording.
Object specifying a channel as a destination.
Object specifying a Composition resource.
Summary information about a Composition.
Object specifying the status of a Destination.
Complex data type that defines destination-configuration objects.
Complex data type that defines destination-detail objects.
Summary information about a Destination.
Settings for transcoding.
Summary information about an EncoderConfiguration.
An occurrence during a stage session.
Configuration information specific to Grid layout, for server-side composition.
IVSRealTime provides the API operation methods for making requests to Amazon Interactive Video Service RealTime.
Configuration information of supported layouts for server-side composition.
Object describing a participant that has joined a stage.
Summary object describing a participant that has joined a stage.
Object specifying a participant token in a stage.
Object specifying a participant token configuration in a stage.
Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html).
Object specifying a public key used to sign stage participant tokens.
Summary information about a public key.
An object representing a configuration to record a stage stream.
A complex type that describes an S3 location where recorded videos will be stored.
Complex data type that defines S3Detail objects.
A complex type that describes an S3 location where recorded videos will be stored.
Object specifying a stage.
Summary information about various endpoints for a stage.
A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage.
Summary information about a stage session.
Summary information about a stage.
A complex type that describes a location where recorded videos will be stored.
Summary information about a storage configuration.
Settings for video.