# AdBuffer
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Inherited Constants](https://developer.android.com/reference/android/media/tv/AdBuffer#inhconstants)\|[Fields](https://developer.android.com/reference/android/media/tv/AdBuffer#lfields)\|[Ctors](https://developer.android.com/reference/android/media/tv/AdBuffer#pubctors)\|[Methods](https://developer.android.com/reference/android/media/tv/AdBuffer#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/media/tv/AdBuffer#inhmethods)
# AdBuffer
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/media/tv/AdBuffer "View this page in Kotlin")\|Java
`
public
final
class
AdBuffer
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
implements
`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`
`
|---|---------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.tv.AdBuffer |
*** ** * ** ***
Buffer for advertisement data.
## Summary
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](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 `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[AdBuffer](https://developer.android.com/reference/android/media/tv/AdBuffer)`>` | [CREATOR](https://developer.android.com/reference/android/media/tv/AdBuffer#CREATOR)
|
| ### Public constructors ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[AdBuffer](https://developer.android.com/reference/android/media/tv/AdBuffer#AdBuffer(int,%20java.lang.String,%20android.os.SharedMemory,%20int,%20int,%20long,%20int))`(int id, `[String](https://developer.android.com/reference/java/lang/String)` mimeType, `[SharedMemory](https://developer.android.com/reference/android/os/SharedMemory)` buffer, int offset, int length, long presentationTimeUs, int flags) ` |
| ### Public methods ||
|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int` | ` `[describeContents](https://developer.android.com/reference/android/media/tv/AdBuffer#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` `[getFlags](https://developer.android.com/reference/android/media/tv/AdBuffer#getFlags())`() ` Gets the buffer flags for this ad buffer. |
| ` int` | ` `[getId](https://developer.android.com/reference/android/media/tv/AdBuffer#getId())`() ` Gets corresponding AD request ID. |
| ` int` | ` `[getLength](https://developer.android.com/reference/android/media/tv/AdBuffer#getLength())`() ` Gets the data length of this ad buffer. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getMimeType](https://developer.android.com/reference/android/media/tv/AdBuffer#getMimeType())`() ` Gets the mime type of the data. |
| ` int` | ` `[getOffset](https://developer.android.com/reference/android/media/tv/AdBuffer#getOffset())`() ` Gets the offset into the shared memory to begin mapping. |
| ` long` | ` `[getPresentationTimeUs](https://developer.android.com/reference/android/media/tv/AdBuffer#getPresentationTimeUs())`() ` Gets the presentation time. |
| ` `[SharedMemory](https://developer.android.com/reference/android/os/SharedMemory) | ` `[getSharedMemory](https://developer.android.com/reference/android/media/tv/AdBuffer#getSharedMemory())`() ` Gets the[SharedMemory](https://developer.android.com/reference/android/os/SharedMemory)which stores the data. |
| ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/media/tv/AdBuffer#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](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` | ` `[wait](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` | ` `[wait](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` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](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` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||
## Fields
### CREATOR
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public constructors
### AdBuffer
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public AdBuffer (int id,
String mimeType,
SharedMemory buffer,
int offset,
int length,
long presentationTimeUs,
int flags)
```
| Parameters ||
|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | `int`
|
| `mimeType` | `String`: This value cannot be`null`.
|
| `buffer` | `SharedMemory`: This value cannot be`null`.
|
| `offset` | `int`
|
| `length` | `int`
|
| `presentationTimeUs` | `long`
|
| `flags` | `int`: Value is either`0`or a combination of[MediaCodec.BUFFER_FLAG_SYNC_FRAME](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_SYNC_FRAME),[MediaCodec.BUFFER_FLAG_KEY_FRAME](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_KEY_FRAME),[MediaCodec.BUFFER_FLAG_CODEC_CONFIG](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_CODEC_CONFIG),[MediaCodec.BUFFER_FLAG_END_OF_STREAM](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_END_OF_STREAM),[MediaCodec.BUFFER_FLAG_PARTIAL_FRAME](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_PARTIAL_FRAME), android.media.MediaCodec.BUFFER_FLAG_MUXER_DATA, and[MediaCodec.BUFFER_FLAG_DECODE_ONLY](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_DECODE_ONLY)
|
## Public methods
### describeContents
Added in[API level 34](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[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](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[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
|
### getFlags
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getFlags ()
```
Gets the buffer flags for this ad buffer.
| Returns ||
|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | The buffer flags for this ad buffer. Value is either`0`or a combination of[MediaCodec.BUFFER_FLAG_SYNC_FRAME](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_SYNC_FRAME),[MediaCodec.BUFFER_FLAG_KEY_FRAME](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_KEY_FRAME),[MediaCodec.BUFFER_FLAG_CODEC_CONFIG](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_CODEC_CONFIG),[MediaCodec.BUFFER_FLAG_END_OF_STREAM](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_END_OF_STREAM),[MediaCodec.BUFFER_FLAG_PARTIAL_FRAME](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_PARTIAL_FRAME), android.media.MediaCodec.BUFFER_FLAG_MUXER_DATA, and[MediaCodec.BUFFER_FLAG_DECODE_ONLY](https://developer.android.com/reference/android/media/MediaCodec#BUFFER_FLAG_DECODE_ONLY)
|
**See also:**
- [MediaCodec](https://developer.android.com/reference/android/media/MediaCodec)
### getId
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getId ()
```
Gets corresponding AD request ID.
| Returns ||
|-------|---------------------------------|
| `int` | The ID of the ad request
|
### getLength
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getLength ()
```
Gets the data length of this ad buffer.
| Returns ||
|-------|----------------------------------------------------|
| `int` | The data length of this ad buffer in bytes.
|
### getMimeType
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getMimeType ()
```
Gets the mime type of the data.
| Returns ||
|--------------------------------------------------------------------|---------------------------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | The mime type of the data. This value cannot be`null`.
|
### getOffset
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getOffset ()
```
Gets the offset into the shared memory to begin mapping.
| Returns ||
|-------|--------------------------------------------------------------------|
| `int` | The offset of this ad buffer in the shared memory in bytes.
|
**See also:**
- [SharedMemory.map(int, int, int)](https://developer.android.com/reference/android/os/SharedMemory#map(int,%20int,%20int))
### getPresentationTimeUs
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public long getPresentationTimeUs ()
```
Gets the presentation time.
| Returns ||
|--------|-----------------------------------------------|
| `long` | The presentation time in microseconds.
|
### getSharedMemory
Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public SharedMemory getSharedMemory ()
```
Gets the[SharedMemory](https://developer.android.com/reference/android/os/SharedMemory)which stores the data.
Information on how the data in this buffer is formatted can be found using[AdRequest.getMetadata()](https://developer.android.com/reference/android/media/tv/AdRequest#getMetadata())
This data lives in a[SharedMemory](https://developer.android.com/reference/android/os/SharedMemory)instance because of the potentially large amount of data needed to store the ad. This optimizes the data communication between the ad data source and the service responsible for its display.
| Returns ||
|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [SharedMemory](https://developer.android.com/reference/android/os/SharedMemory) | The[SharedMemory](https://developer.android.com/reference/android/os/SharedMemory)that stores the data for this ad buffer. This value cannot be`null`.
|
**See also:**
- [SharedMemory.create(String, int)](https://developer.android.com/reference/android/os/SharedMemory#create(java.lang.String,%20int))
### writeToParcel
Added in[API level 34](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[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|