Package com.amazonaws.ivs.broadcast

Interface Summary

Interface	Description
AudioDevice.StatsCallback
Builder<T>	A utility interface used by BroadcastConfiguration to enable .with and .changing
DeviceDiscovery.OnDevicesChangedListener	A listener which notifies when the list of devices changes
ImageDevice.FrameCallback
Releasable	Marks objects that must be released with release()
Stage.Strategy	The Strategy is the decision engine associated with a Stage.
StageRenderer	An interface to implement that can be used to build user interfaces.
StageStream.Listener	StageStream delegate interface to receive callbacks when RTCStats is ready after calling StageStream.requestRTCStats() or StageStream is muted
TypedLambda<T>	A utility interface used by BroadcastSession for device change callbacks

Class Summary

Class	Description
AudioDevice	Audio input sources must conform to this interface
AudioLocalStageStream
AudioSource	Use AudioSource as a generic source to send app-generated audio to the SDK in LPCM format.
AudioStageStream	This is a child class of StageStream and provide audio specific APIs and implementations
Bluetooth	Manage the state of Bluetooth SCO capabilities
BroadcastConfiguration	Configuration properties for a BroadcastSession Changing any properties on this object after providing it to `BroadcastSession` will not have any effect.
BroadcastConfiguration.Audio
BroadcastConfiguration.AutoReconnect	An object that can configure SDK auto-reconnect functionality.
BroadcastConfiguration.Mixer	Audio and Video Mixer properties.
BroadcastConfiguration.Mixer.Slot	A slot represents an on-screen and audible element that can be transitioned over time and bound and unbound to input devices.
BroadcastConfiguration.Network
BroadcastConfiguration.Vec2
BroadcastConfiguration.Vec4
BroadcastConfiguration.Video
BroadcastSession	BroadcastSession is the primary interaction point with the IVS Broadcast SDK.
BroadcastSession.Listener	Provide a listener to receive status updates and errors from the SDK.
BroadcastSessionTest	A handle on the network quality test.
BroadcastSessionTest.Result	Information about the state of a network quality test.
CameraSource	CameraSource represents a camera input device
CustomAudioSource	An extension of AudioSource to send app-generated audio to the SDK in LPCM format.
CustomImageSource	An extension of SurfaceSource to send app-generated video to the SDK.
Device	Represents an input device such as a camera or microphone
Device.Descriptor	Represents an input device's description.
DeviceDiscovery	Use this class to discover local devices, such as microphones or cameras, to attach to the SDK.
ImageDevice	Image and video input sources must conform to this interface
ImageDeviceFrame	A data class providing metadata about the frames going through an ImageDevice.
ImageLocalStageStream
ImagePreviewSurfaceTarget	A special kind of preview which is not an Android View.
ImagePreviewSurfaceView	A view that will render a preview of either an ImageDevice, or the composited preview of the entire BroadcastSession.
ImagePreviewView	A view that will render a preview of either an ImageDevice, or the composited preview of the entire BroadcastSession.
ImageStageStream	This is a child class of StageStream and provide video specific APIs and implementations
LocalAudioStats
LocalStageStream	This class represents either local audio stream or local video stream, and it is used in Stage.Strategy to guide SDK what stream to publish
LocalVideoStats
Mixer	The mixer determines the final on-screen and in-ear state for visual elements and audio.
ParticipantInfo	Information about a participant
Presets	Configuration and Device Presets
Presets.Configuration	BroadcastConfiguration presets.
Presets.Devices	Device presets.
QualityStats
RemoteAudioStats
RemoteVideoStats
Stage	The main interface for host Application to create Stage session and interact with created session
StageAudioConfiguration
StageAudioManager	Manages audio settings for all stages.
StageConfiguration	Properties for Stage.
StageStream	A media stream that contains a single Device and a single type of media data (audio or video).
StageVideoConfiguration
StageVideoConfiguration.Simulcast	Simulcast configuration.
SurfaceSource	An image source backed by an Android Surface.
SystemCaptureService
TransmissionStats	TransmissionStats contains statistics on the broadcast's current measured bitrate, recommended bitrate by the SDK's adaptive bitrate algorithm, average round trip time, broadcast quality (relative to configured minimum and maximum bitrates), and network health.

Enum Summary

Enum	Description
AudioDevice.Format	Audio data representations
BroadcastConfiguration.AspectMode	The AspectMode determines how an image's aspect ratio will be maintained.
BroadcastConfiguration.AudioSampleRate
BroadcastConfiguration.AutomaticBitrateProfile	Profiles for the automatic video bitrate behavior.
BroadcastConfiguration.LogLevel
BroadcastSession.RetryState	A value representing the BroadcastSession retry state.
BroadcastSession.State
BroadcastSessionTest.Status	The state of a network quality test
Device.Descriptor.DeviceType
Device.Descriptor.Position	Physical device position
Device.Descriptor.StreamType	Media types present in a stream
ErrorType	Enumeration of error codes used in BroadcastSession.Listener.onError(BroadcastException).
ImageDevice.Rotation	Utility enum that defines common rotations by degree in radians.
ParticipantInfo.Capabilities
QualityStats.NetworkQuality
Stage.ConnectionState	ConnectionState indicates current Stage session state
Stage.PublishState	The various potential publish states for a participant
Stage.SubscribeState	The various potential subscribe states for a participant
Stage.SubscribeType	SubscribeType is used in Stage.Strategy to indicate whether SDK should subscribe and what media type it should subscribe
StageAudioManager.ContentType
StageAudioManager.Source
StageAudioManager.Usage
StageAudioManager.UseCasePreset
StageStream.Type	Media type of StageStream
StageVideoConfiguration.DegradationPreference
TransmissionStats.BroadcastQuality	BroadcastQuality represents the quality of the stream based on the bitrate minimum and maximum provided on session configuration.
TransmissionStats.NetworkHealth	NetworkHealth represents the current health of the network.

Exception Summary

Exception	Description
BroadcastException