Class Index

A B C D E I L M P R S T

A

AudioDevice Audio input sources must conform to this interface  
AudioDevice.Format Audio data representations  
AudioDevice.StatsCallback  
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  

B

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.AspectMode The AspectMode determines how an image's aspect ratio will be maintained. 
BroadcastConfiguration.Audio  
BroadcastConfiguration.AudioSampleRate  
BroadcastConfiguration.AutomaticBitrateProfile Profiles for the automatic video bitrate behavior. 
BroadcastConfiguration.LogLevel  
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.Vec2  
BroadcastConfiguration.Vec4  
BroadcastConfiguration.Video  
BroadcastException  
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. 
BroadcastSession.State  
BroadcastSessionTest A handle on the network quality test. 
BroadcastSessionTest.Result Information about the state of a network quality test. 
BroadcastSessionTest.Status The state of a network quality test  
BuildConfig  
Builder<T> A utility interface used by BroadcastConfiguration to enable .with and .changing  

C

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. 

D

Device Represents an input device such as a camera or microphone  
Device.Descriptor Represents an input device's description. 
Device.Descriptor.DeviceType  
Device.Descriptor.Position Physical device position  
Device.Descriptor.StreamType Media types present in a stream  
DeviceDiscovery Use this class to discover local devices, such as microphones or cameras, to attach to the SDK. 
DeviceDiscovery.OnDevicesChangedListener A listener which notifies when the list of devices changes  

E

ErrorType Enumeration of error codes used in onError(BroadcastException)

I

ImageDevice Image and video input sources must conform to this interface  
ImageDevice.Rotation Utility enum that defines common rotations by degree in radians. 
ImageLocalStageStream  
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  

L

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  

M

Mixer The mixer determines the final on-screen and in-ear state for visual elements and audio. 

P

ParticipantInfo Information about a participant  
ParticipantInfo.Capabilities  
Presets Configuration and Device Presets  
Presets.Configuration BroadcastConfiguration presets. 
Presets.Devices Device presets. 

R

Releasable Marks objects that must be released with release()  

S

Stage The main interface for host Application to create Stage session and interact with created session  
Stage.ConnectionState ConnectionState indicates current Stage ession state  
Stage.PublishState The various potential publish states for a participant  
Stage.Strategy The Strategy is the decision engine associated with a Stage. 
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  
StageConfiguration Properties for Stage. 
StageRenderer An interface to implement that can be used to build user interfaces. 
StageStream A media stream that contains a single Device and a single type of media data (audio or video). 
StageStream.Listener StageStream delegate interface to receive callbacks when RTCStats is ready after calling requestRTCStats() or StageStream is muted  
StageStream.Type Media type of StageStream  
StageVideoConfiguration  
StageVideoConfiguration.DegradationPreference  
SurfaceSource An image source backed by an Android Surface. 
SystemCaptureService  

T

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. 
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. 
TypedLambda<T> A utility interface used by BroadcastSession for device change callbacks