MediaSyncEvent

public class MediaSyncEvent
extends Object implements Parcelable

java.lang.Object
   ↳ 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

int SYNC_EVENT_NONE

No sync event specified.

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

Fields

public static final Creator<MediaSyncEvent> CREATOR

Public methods

static MediaSyncEvent createEvent(int eventType)

Creates a synchronization event of the sepcified type.

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getAudioSessionId()

Gets the synchronization event audio session ID.

int getType()

Gets the synchronization event type.

int hashCode()

Returns a hash code value for the object.

MediaSyncEvent setAudioSessionId(int audioSessionId)

Sets the event source audio session ID.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

SYNC_EVENT_NONE

Added in API level 16
public static final int SYNC_EVENT_NONE

No sync event specified. When used with a synchronized playback or capture method, the behavior is equivalent to calling the corresponding non synchronized method.

Constant Value: 0 (0x00000000)

SYNC_EVENT_PRESENTATION_COMPLETE

Added in API level 16
public static final 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. A synchronization of this type requires a source audio session ID to be set via setAudioSessionId(int) method.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 31
public static final Creator<MediaSyncEvent> CREATOR

Public methods

createEvent

Added in API level 16
public static MediaSyncEvent createEvent (int eventType)

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.

Returns
MediaSyncEvent the MediaSyncEvent created.

Throws
java.lang.IllegalArgumentException
IllegalArgumentException

describeContents

Added in API level 31
public int describeContents ()

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.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 16
public boolean equals (Object o)

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAudioSessionId

Added in API level 16
public int getAudioSessionId ()

Gets the synchronization event audio session ID.

Returns
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
public int getType ()

Gets the synchronization event type.

Returns
int the synchronization event type.

hashCode

Added in API level 16
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.

Returns
int a hash code value for this object.

setAudioSessionId

Added in API level 16
public MediaSyncEvent setAudioSessionId (int audioSessionId)

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.

Returns
MediaSyncEvent the MediaSyncEvent the method is called on.

Throws
java.lang.IllegalArgumentException
IllegalArgumentException

toString

Added in API level 16
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31
public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES