com.csipsimple.api

Class MediaState

java.lang.Object

com.csipsimple.api.MediaState

All Implemented Interfaces:

Parcelable

public class MediaState
extends Object
implements Parcelable

Represents state of the media device layer
This class helps to serialize/deserialize the state of the media layer
The fields it contains are direclty available.
Changing these fields has no effect on the device audio : it's only a structured holder for datas
This class is not related to SIP media state this is managed by SipCallSession.MediaState

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
boolean	canBluetoothSco Gives phone capability to route to bluetooth SCO
boolean	canMicrophoneMute Gives phone capability to mute microphone
boolean	canSpeakerphoneOn Gives phone capability to route to speaker
static Parcelable.Creator<MediaState>	CREATOR Parcelable creator.
boolean	isBluetoothScoOn Whether the audio routes to Bluetooth SCO
boolean	isMicrophoneMute Whether the microphone is currently muted
boolean	isSpeakerphoneOn Whether the audio routes to the speaker
int	primaryKey Primary key for the parcelable object

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
MediaState() Constructor for a media state object It will contains default values for all flags This class as no setter/getter for members flags It's aim is to allow to serialize/deserialize easily the state of media layer, not to modify it

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

primaryKey

public int primaryKey

Primary key for the parcelable object

isMicrophoneMute

public boolean isMicrophoneMute

Whether the microphone is currently muted

isSpeakerphoneOn

public boolean isSpeakerphoneOn

Whether the audio routes to the speaker

isBluetoothScoOn

public boolean isBluetoothScoOn

Whether the audio routes to Bluetooth SCO

canMicrophoneMute

public boolean canMicrophoneMute

Gives phone capability to mute microphone

canSpeakerphoneOn

public boolean canSpeakerphoneOn

Gives phone capability to route to speaker

canBluetoothSco

public boolean canBluetoothSco

Gives phone capability to route to bluetooth SCO

CREATOR

public static final Parcelable.Creator<MediaState> CREATOR

Parcelable creator. So that it can be passed as an argument of the aidl interface

Constructor Detail

MediaState

public MediaState()

Constructor for a media state object
It will contains default values for all flags This class as no setter/getter for members flags
It's aim is to allow to serialize/deserialize easily the state of media layer, not to modify it

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

See Also:

Parcelable.describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

See Also:

Parcelable.writeToParcel(Parcel, int)