# AudioPacket

<a id="audiopacket"></a>

# AudioPacket

```cpp
#include <icy/av/packet.h>

struct AudioPacket
```

[Defined in src/av/include/icy/av/packet.h:156](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L156)

> **Inherits:** [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket)
> **Subclassed by:** [`PlanarAudioPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-PlanarAudioPacket.md#planaraudiopacket)

Audio packet for interleaved formats.

## List of all members

| Name | Kind | Owner |
|------|------|-------|
| [`numSamples`](#numsamples) | `variable` | Declared here |
| [`avpacket`](#avpacket-1) | `variable` | Declared here |
| [`AudioPacket`](#audiopacket-1) | `function` | Declared here |
| [`~AudioPacket`](#audiopacket-2) | `function` | Declared here |
| [`clone`](#clone-7) | `function` | Declared here |
| [`samples`](#samples) | `function` | Declared here |
| [`className`](#classname-8) | `function` | Declared here |
| [`time`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#time-2) | `variable` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-1) | `function` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-2) | `function` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-3) | `function` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`~MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-4) | `function` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`clone`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#clone-4) | `function` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`className`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#classname-5) | `function` | Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket) |
| [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-5) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-6) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-7) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`~RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-8) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`clone`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#clone-3) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`copyData`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#copydata) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`read`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#read-2) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`write`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#write-14) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`data`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#data-4) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`size`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#size-7) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`className`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#classname-2) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`ownsBuffer`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#ownsbuffer) | `function` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`_data`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#_data-2) | `variable` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`_size`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#_size-2) | `variable` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`_owned`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#_owned) | `variable` | Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4) |
| [`operator<<`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#operator-41) | `friend` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`opaque`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#opaque) | `variable` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`info`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#info) | `variable` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`flags`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#flags) | `variable` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket-1) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket-2) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`operator=`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#operator-42) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`clone`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#clone-1) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`~IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket-3) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`read`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#read-1) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`write`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#write-4) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`size`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#size-1) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`hasData`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#hasdata) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`data`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#data-2) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`constData`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#constdata) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`className`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#classname-1) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |
| [`print`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#print) | `function` | Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) |

## Inherited from [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket)

| Kind | Name | Description |
|------|------|-------------|
| `variable` | [`time`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#time-2)  | Presentation timestamp in microseconds. |
| `function` | [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-1) `inline` | Construct with a non-owning or owning mutable buffer. |
| `function` | [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-2) `inline` | Construct with const data (copied, owning). |
| `function` | [`MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-3) `inline` | Copy constructor. |
| `function` | [`~MediaPacket`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#mediapacket-4) `virtual` | Defaulted destructor. |
| `function` | [`clone`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#clone-4) `virtual` `const` `inline` `override` |  |
| `function` | [`className`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#classname-5) `virtual` `const` `inline` `override` | Returns the class name of this packet type for logging and diagnostics. |

## Inherited from [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-4)

| Kind | Name | Description |
|------|------|-------------|
| `function` | [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-5) `inline` | Construct with borrowed (non-owning) buffer. |
| `function` | [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-6) `inline` | Construct with const data (copied, owning). |
| `function` | [`RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-7) `inline` | Copy constructor (always copies data). |
| `function` | [`~RawPacket`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#rawpacket-8) `virtual` | Defaulted destructor. |
| `function` | [`clone`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#clone-3) `virtual` `const` `inline` `override` |  |
| `function` | [`copyData`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#copydata) `virtual` `inline` | Copies data into an internally owned buffer, replacing any prior content. |
| `function` | [`read`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#read-2) `virtual` `inline` `override` | Reads from the buffer by copying its contents into an owned buffer. |
| `function` | [`write`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#write-14) `virtual` `const` `inline` `override` | Appends the packet data to the given output buffer. |
| `function` | [`data`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#data-4) `virtual` `const` `inline` `override` |  |
| `function` | [`size`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#size-7) `virtual` `const` `inline` `override` |  |
| `function` | [`className`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#classname-2) `virtual` `const` `inline` `override` | Returns the class name of this packet type for logging and diagnostics. |
| `function` | [`ownsBuffer`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#ownsbuffer) `const` `inline` |  |
| `variable` | [`_data`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#_data-2)  |  |
| `variable` | [`_size`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#_size-2)  |  |
| `variable` | [`_owned`](https://auscaster.com/icey/docs/api-reference/icy-RawPacket.md#_owned)  |  |

## Inherited from [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket)

| Kind | Name | Description |
|------|------|-------------|
| `friend` | [`operator<<`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#operator-41) `inline` | [Stream](https://auscaster.com/icey/docs/api-reference/icy-Stream.md#stream) insertion operator; delegates to [print()](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#print). |
| `variable` | [`opaque`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#opaque)  | Optional type-safe context data. Use std::any_cast to retrieve. Lifetime of the stored value is tied to the packet's lifetime. |
| `variable` | [`info`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#info)  | Optional extra information about the packet. |
| `variable` | [`flags`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#flags)  | Provides basic information about the packet. |
| `function` | [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket-1) `inline` |  |
| `function` | [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket-2) `inline` | Copy constructor; clones the info object if present. |
| `function` | [`operator=`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#operator-42) `inline` | Copy assignment; clones the info object if present. |
| `function` | [`clone`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#clone-1) `virtual` `const` | Returns a heap-allocated deep copy of this packet. |
| `function` | [`~IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket-3) `virtual` | Defaulted destructor. |
| `function` | [`read`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#read-1) `virtual` | Read/parse to the packet from the given input buffer. The number of bytes read is returned. |
| `function` | [`write`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#write-4) `virtual` `const` | Copy/generate to the packet given output buffer. The number of bytes written can be obtained from the buffer. |
| `function` | [`size`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#size-1) `virtual` `const` `inline` | The size of the packet in bytes. |
| `function` | [`hasData`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#hasdata) `virtual` `const` `inline` | Returns true if the packet has a non-null data pointer. |
| `function` | [`data`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#data-2) `virtual` `const` `inline` | The packet data pointer for buffered packets. |
| `function` | [`constData`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#constdata) `virtual` `const` `inline` | The const packet data pointer for buffered packets. |
| `function` | [`className`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#classname-1) `virtual` `const` | Returns the class name of this packet type for logging and diagnostics. |
| `function` | [`print`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#print) `virtual` `const` `inline` | Prints a human-readable representation to the given stream. |

## Public Attributes

| Return | Name | Description |
|--------|------|-------------|
| `size_t` | [`numSamples`](#numsamples)  | Number of audio samples per channel. |
| `AVPacket *` | [`avpacket`](#avpacket-1)  | Non-owning pointer to the encoded AVPacket from FFmpeg. Set by [AudioEncoder](https://auscaster.com/icey/docs/api-reference/icy-av-AudioEncoder.md#audioencoder), read by [MultiplexEncoder](https://auscaster.com/icey/docs/api-reference/icy-av-MultiplexEncoder.md#multiplexencoder). |

---

<a id="numsamples"></a>

### numSamples

```cpp
size_t numSamples
```

[Defined in src/av/include/icy/av/packet.h:158](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L158)

Number of audio samples per channel.

---

<a id="avpacket-1"></a>

### avpacket

```cpp
AVPacket * avpacket = nullptr
```

[Defined in src/av/include/icy/av/packet.h:162](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L162)

Non-owning pointer to the encoded AVPacket from FFmpeg. Set by [AudioEncoder](https://auscaster.com/icey/docs/api-reference/icy-av-AudioEncoder.md#audioencoder), read by [MultiplexEncoder](https://auscaster.com/icey/docs/api-reference/icy-av-MultiplexEncoder.md#multiplexencoder).

## Public Methods

| Return | Name | Description |
|--------|------|-------------|
|  | [`AudioPacket`](#audiopacket-1) `inline` | Construct an audio packet with an interleaved sample buffer. |
|  | [`~AudioPacket`](#audiopacket-2) `virtual` | Defaulted destructor. |
| std::unique_ptr< [`IPacket`](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) > | [`clone`](#clone-7) `virtual` `const` `inline` `override` |  |
| `uint8_t *` | [`samples`](#samples) `virtual` `const` `inline` |  |
| `const char *` | [`className`](#classname-8) `virtual` `const` `inline` `override` | Returns the class name of this packet type for logging and diagnostics. |

---

<a id="audiopacket-1"></a>

### AudioPacket

`inline`

```cpp
inline AudioPacket(uint8_t * data = nullptr, size_t size = 0, size_t numSamples = 0, int64_t time = 0)
```

[Defined in src/av/include/icy/av/packet.h:169](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L169)

Construct an audio packet with an interleaved sample buffer.

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `data` | `uint8_t *` | Pointer to the interleaved sample buffer (may be null). |
| `size` | `size_t` | Size of the buffer in bytes. |
| `numSamples` | `size_t` | Number of samples per channel. |
| `time` | `int64_t` | Presentation timestamp in microseconds. |

---

<a id="audiopacket-2"></a>

### ~AudioPacket

`virtual`

```cpp
virtual ~AudioPacket() = default
```

[Defined in src/av/include/icy/av/packet.h:177](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L177)

Defaulted destructor.

---

<a id="clone-7"></a>

### clone

`virtual` `const` `inline` `override`

```cpp
virtual inline std::unique_ptr< IPacket > clone() const override
```

[Defined in src/av/include/icy/av/packet.h:180](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L180)

#### Returns
A heap-allocated copy of this packet.

#### Reimplements

- [`MediaPacket::clone`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#clone-4)

#### Reimplemented by

- [`PlanarAudioPacket::clone`](https://auscaster.com/icey/docs/api-reference/icy-av-PlanarAudioPacket.md#clone-8)

---

<a id="samples"></a>

### samples

`virtual` `const` `inline`

```cpp
virtual inline uint8_t * samples() const
```

[Defined in src/av/include/icy/av/packet.h:183](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L183)

#### Returns
A pointer to the raw interleaved sample buffer.

---

<a id="classname-8"></a>

### className

`virtual` `const` `inline` `override`

```cpp
virtual inline const char * className() const override
```

[Defined in src/av/include/icy/av/packet.h:188](https://github.com/auscaster/icey/blob/main/src/av/include/icy/av/packet.h#L188)

Returns the class name of this packet type for logging and diagnostics.

#### Reimplements

- [`MediaPacket::className`](https://auscaster.com/icey/docs/api-reference/icy-av-MediaPacket.md#classname-5)

#### Reimplemented by

- [`PlanarAudioPacket::className`](https://auscaster.com/icey/docs/api-reference/icy-av-PlanarAudioPacket.md#classname-9)