MediaSyncEvent

Kotlin |Java

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	`SYNC_EVENT_NONE` No sync event specified.
static Int	`SYNC_EVENT_PRESENTATION_COMPLETE` 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

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
open static MediaSyncEvent!	`createEvent(eventType: Int)` Creates a synchronization event of the sepcified type.
open Int	`describeContents()`
open Boolean	`equals(other: Any?)`
open Int	`getAudioSessionId()` Gets the synchronization event audio session ID.
open Int	`getType()` Gets the synchronization event type.
open Int	`hashCode()`
open MediaSyncEvent!	`setAudioSessionId(audioSessionId: Int)` Sets the event source audio session ID.
open String	`toString()`
open Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<MediaSyncEvent!>	`CREATOR`

Constants

SYNC_EVENT_NONE

Added in API level 16

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: 0

SYNC_EVENT_PRESENTATION_COMPLETE

Added in API level 16

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: 1

Public methods

createEvent

Added in API level 16

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

Added in API level 31

open fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 16

open fun equals(other: Any?): Boolean

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

Added in API level 16

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

Added in API level 16

open fun getType(): Int

Gets the synchronization event type.

Return
`Int`	the synchronization event type.

hashCode

Added in API level 16

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.

setAudioSessionId

Added in API level 16

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

Added in API level 16

open fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 31

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 31

static val CREATOR: Parcelable.Creator<MediaSyncEvent!>