Added in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/media/MediaSyncEvent#constants) \| [Inherited Constants](https://developer.android.com/reference/android/media/MediaSyncEvent#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/MediaSyncEvent#lfields) \| [Methods](https://developer.android.com/reference/android/media/MediaSyncEvent#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/MediaSyncEvent#inhmethods)
# MediaSyncEvent
*** ** * ** ***
` public class MediaSyncEvent `
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `
|---|---|
| [java.lang.Object](https://developer.android.com/reference/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, `https://developer.android.com/reference/android/media/AudioRecord#startRecording(android.media.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 `https://developer.android.com/reference/android/media/MediaPlayer`, `https://developer.android.com/reference/android/media/AudioTrack` or `https://developer.android.com/reference/android/media/ToneGenerator`) by use of the getAudioSessionId() method.
## Summary
| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/MediaSyncEvent#SYNC_EVENT_NONE` No sync event specified. |
| `int` | `https://developer.android.com/reference/android/media/MediaSyncEvent#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 interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`
Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`
Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`".
| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator` | `https://developer.android.com/reference/android/media/MediaSyncEvent#CREATOR`
|
| ### Public methods ||
|---|---|
| ` static https://developer.android.com/reference/android/media/MediaSyncEvent` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#createEvent(int)(int eventType) ` Creates a synchronization event of the sepcified type. |
| ` int` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` int` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#getAudioSessionId()() ` Gets the synchronization event audio session ID. |
| ` int` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#getType()() ` Gets the synchronization event type. |
| ` int` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/android/media/MediaSyncEvent` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#setAudioSessionId(int)(int audioSessionId) ` Sets the event source audio session ID. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/media/MediaSyncEvent#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |
### Inherited methods
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `
Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `
Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class` ` https://developer.android.com/reference/java/lang/Object#getClass()() `
Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `
Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `
Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `
Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `
Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `
Flatten this object in to a Parcel.
## Constants
### SYNC_EVENT_NONE
Added in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/media/MediaSyncEvent#setAudioSessionId(int)` method.
Constant Value: 1 (0x00000001)
## Fields
### CREATOR
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public methods
### createEvent
Added in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/media/MediaSyncEvent#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 ||
|---|---|
| `https://developer.android.com/reference/android/media/MediaSyncEvent` | the MediaSyncEvent created.
|
| Throws ||
|---|---|
| | java.lang.IllegalArgumentException |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | |
### describeContents
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#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 - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |
### equals
Added in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getType ()
```
Gets the synchronization event type.
| Returns ||
|---|---|
| `int` | the synchronization event type.
|
### hashCode
Added in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/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 `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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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. `https://developer.android.com/reference/android/media/MediaSyncEvent#SYNC_EVENT_PRESENTATION_COMPLETE`). For instance, the audio session ID can be retrieved via `https://developer.android.com/reference/android/media/MediaPlayer#getAudioSessionId()` when monitoring an event on a particular MediaPlayer.
| Parameters ||
|---|---|
| `audioSessionId` | `int`: the audio session ID of the event source being monitored.
|
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/MediaSyncEvent` | the MediaSyncEvent the method is called on.
|
| Throws ||
|---|---|
| | java.lang.IllegalArgumentException |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | |
### toString
Added in [API level 16](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object.
|
### writeToParcel
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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 `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |