MediaSyncEvent
open class MediaSyncEvent : Parcelable
| kotlin.Any | |
| ↳ | android.media.MediaSyncEvent |
The MediaSyncEvent class defines events that can be used to synchronize playback or capture actions between different players and recorders.
For instance, AudioRecord.startRecording(MediaSyncEvent) is used to start capture only when the playback on a particular audio session is complete. The audio session ID is retrieved from a player (e.g MediaPlayer, AudioTrack or ToneGenerator) by use of the getAudioSessionId() method.
Summary
| Constants | |
|---|---|
| static Int |
No sync event specified. |
| static Int |
The corresponding action is triggered only when the presentation is completed (meaning the media has been presented to the user) on the specified session. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| open static MediaSyncEvent! |
createEvent(eventType: Int)Creates a synchronization event of the sepcified type. |
| open Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Int |
Gets the synchronization event audio session ID. |
| open Int |
getType()Gets the synchronization event type. |
| open Int |
hashCode()Returns a hash code value for the object. |
| open MediaSyncEvent! |
setAudioSessionId(audioSessionId: Int)Sets the event source audio session ID. |
| open String |
toString()Returns a string representation of the object. |
| open Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<MediaSyncEvent!> | |
Constants
SYNC_EVENT_NONE
static val SYNC_EVENT_NONE: Int
No sync event specified. When used with a synchronized playback or capture method, the behavior is equivalent to calling the corresponding non synchronized method.
Value: 0SYNC_EVENT_PRESENTATION_COMPLETE
static val SYNC_EVENT_PRESENTATION_COMPLETE: Int
The corresponding action is triggered only when the presentation is completed (meaning the media has been presented to the user) on the specified session. A synchronization of this type requires a source audio session ID to be set via setAudioSessionId(int) method.
Value: 1Public methods
createEvent
open static fun createEvent(eventType: Int): MediaSyncEvent!
Creates a synchronization event of the sepcified type.
The type specifies which kind of event is monitored. For instance, event SYNC_EVENT_PRESENTATION_COMPLETE corresponds to the audio being presented to the user on a particular audio session.
| Parameters | |
|---|---|
eventType |
Int: the synchronization event type. |
| Return | |
|---|---|
MediaSyncEvent! |
the MediaSyncEvent created. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
|
describeContents
open fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
open fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAudioSessionId
open fun getAudioSessionId(): Int
Gets the synchronization event audio session ID.
| Return | |
|---|---|
Int |
the synchronization audio session ID. The returned audio session ID is 0 if it has not been set. |
getType
open fun getType(): Int
Gets the synchronization event type.
| Return | |
|---|---|
Int |
the synchronization event type. |
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
setAudioSessionId
open fun setAudioSessionId(audioSessionId: Int): MediaSyncEvent!
Sets the event source audio session ID.
The audio session ID specifies on which audio session the synchronization event should be monitored. It is mandatory for certain event types (e.g. SYNC_EVENT_PRESENTATION_COMPLETE). For instance, the audio session ID can be retrieved via MediaPlayer.getAudioSessionId() when monitoring an event on a particular MediaPlayer.
| Parameters | |
|---|---|
audioSessionId |
Int: the audio session ID of the event source being monitored. |
| Return | |
|---|---|
MediaSyncEvent! |
the MediaSyncEvent the method is called on. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
|
toString
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
open fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|