# PacketProcessor

<a id="packetprocessor"></a>

# PacketProcessor

```cpp
#include <icy/packetstream.h>

class PacketProcessor
```

[Defined in src/base/include/icy/packetstream.h:116](https://github.com/auscaster/icey/blob/main/src/base/include/icy/packetstream.h#L116)

> **Inherits:** [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter)
> **Subclassed by:** [`AsyncPacketQueue< PacketT >`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#asyncpacketqueue), [`PlanarAudioPacket >`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#asyncpacketqueue), [`AsyncPacketQueue< VisionFramePacket >`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#asyncpacketqueue), [`AsyncPacketQueue< T >`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#asyncpacketqueue), [`StreamWriter`](https://auscaster.com/icey/docs/api-reference/icy-StreamWriter.md#streamwriter), [`SyncPacketQueue< T >`](https://auscaster.com/icey/docs/api-reference/icy-SyncPacketQueue.md#syncpacketqueue), [`AudioPacketEncoder`](https://auscaster.com/icey/docs/api-reference/icy-av-AudioPacketEncoder.md#audiopacketencoder), [`FPSLimiter`](https://auscaster.com/icey/docs/api-reference/icy-av-FPSLimiter.md#fpslimiter), [`MultiplexPacketEncoder`](https://auscaster.com/icey/docs/api-reference/icy-av-MultiplexPacketEncoder.md#multiplexpacketencoder), [`VideoPacketEncoder`](https://auscaster.com/icey/docs/api-reference/icy-av-VideoPacketEncoder.md#videopacketencoder), [`ChunkedAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-ChunkedAdapter.md#chunkedadapter), [`MultipartAdapter`](https://auscaster.com/icey/docs/api-reference/icy-http-MultipartAdapter.md#multipartadapter), [`FrameNormalizer`](https://auscaster.com/icey/docs/api-reference/icy-vision-FrameNormalizer.md#framenormalizer), [`FrameSampler`](https://auscaster.com/icey/docs/api-reference/icy-vision-FrameSampler.md#framesampler), [`WebRtcTrackSender`](https://auscaster.com/icey/docs/api-reference/icy-wrtc-WebRtcTrackSender.md#webrtctracksender)

This class is a virtual interface for creating PacketStreamAdapters which process that and emit the [IPacket](https://auscaster.com/icey/docs/api-reference/icy-IPacket.md#ipacket) type.

## List of all members

| Name | Kind | Owner |
|------|------|-------|
| [`PacketProcessor`](#packetprocessor-1) | `function` | Declared here |
| [`process`](#process-1) | `function` | Declared here |
| [`accepts`](#accepts-1) | `function` | Declared here |
| [`operator<<`](#operator-69) | `function` | Declared here |
| [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-1) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`~PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-2) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-1) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-2) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-3) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-4) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-5) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`getEmitter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#getemitter) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`retention`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#retention-1) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`onStreamStateChange`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#onstreamstatechange-1) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`_emitter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#_emitter) | `variable` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-3) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`operator=`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#operator-72) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-4) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |
| [`operator=`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#operator-73) | `function` | Inherited from [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter) |

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

| Kind | Name | Description |
|------|------|-------------|
| `function` | [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-1)  | Construct the adapter, binding it to the given packet signal. |
| `function` | [`~PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-2) `virtual` `inline` |  |
| `function` | [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-1) `virtual` | Emit a mutable raw buffer as a packet. |
| `function` | [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-2) `virtual` | Emit a read-only raw buffer as a packet (data is copied internally). |
| `function` | [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-3) `virtual` | Emit a string as a packet (data is copied internally). |
| `function` | [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-4) `virtual` | Emit a flag-only packet carrying no payload data. |
| `function` | [`emit`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#emit-5) `virtual` | Emit an existing packet directly onto the outgoing signal. |
| `function` | [`getEmitter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#getemitter)  | Returns a reference to the outgoing packet signal. |
| `function` | [`retention`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#retention-1) `virtual` `const` | Returns how this adapter treats incoming packet lifetime. Most adapters are synchronous and therefore only borrow the packet for the current call chain. Queue-style adapters override this to advertise that they clone before deferred use. Callers may treat the first adapter reporting Cloned or Retained as the explicit ownership boundary in the stream graph. |
| `function` | [`onStreamStateChange`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#onstreamstatechange-1) `virtual` `inline` | Called by the [PacketStream](https://auscaster.com/icey/docs/api-reference/icy-PacketStream.md#packetstream) to notify when the internal [Stream](https://auscaster.com/icey/docs/api-reference/icy-Stream.md#stream) state changes. On receiving the Stopped state, it is the responsibility of the adapter to have ceased all outgoing packet transmission, especially in multi-thread scenarios. |
| `variable` | [`_emitter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#_emitter)  |  |
| `function` | [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-3)  | NonCopyable and NonMovable. |
| `function` | [`operator=`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#operator-72)  | Deleted assignment operator. |
| `function` | [`PacketStreamAdapter`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#packetstreamadapter-4)  | Deleted constructor. |
| `function` | [`operator=`](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#operator-73)  | Deleted assignment operator. |

## Public Methods

| Return | Name | Description |
|--------|------|-------------|
|  | [`PacketProcessor`](#packetprocessor-1) `inline` |  |
| `void` | [`process`](#process-1) `virtual` | This method performs processing on the given packet and emits the result. |
| `bool` | [`accepts`](#accepts-1) `virtual` `inline` | This method ensures compatibility with the given packet type. Return false to reject the packet. |
| `void` | [`operator<<`](#operator-69) `virtual` `inline` | [Stream](https://auscaster.com/icey/docs/api-reference/icy-Stream.md#stream) operator alias for [process()](#process-1) |

---

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

### PacketProcessor

`inline`

```cpp
inline PacketProcessor(PacketSignal & emitter)
```

[Defined in src/base/include/icy/packetstream.h:119](https://github.com/auscaster/icey/blob/main/src/base/include/icy/packetstream.h#L119)

---

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

### process

`virtual`

```cpp
virtual void process(IPacket & packet)
```

[Defined in src/base/include/icy/packetstream.h:129](https://github.com/auscaster/icey/blob/main/src/base/include/icy/packetstream.h#L129)

This method performs processing on the given packet and emits the result.

Processors that defer work asynchronously must either clone the packet or retain an owned equivalent. See [retention()](https://auscaster.com/icey/docs/api-reference/icy-PacketStreamAdapter.md#retention-1).

#### Reimplemented by

- [`FPSLimiter::process`](https://auscaster.com/icey/docs/api-reference/icy-av-FPSLimiter.md#process-11)
- [`MultipartAdapter::process`](https://auscaster.com/icey/docs/api-reference/icy-http-MultipartAdapter.md#process-16)
- [`AudioPacketEncoder::process`](https://auscaster.com/icey/docs/api-reference/icy-av-AudioPacketEncoder.md#process-12)
- [`MultiplexPacketEncoder::process`](https://auscaster.com/icey/docs/api-reference/icy-av-MultiplexPacketEncoder.md#process-14)
- [`VideoPacketEncoder::process`](https://auscaster.com/icey/docs/api-reference/icy-av-VideoPacketEncoder.md#process-13)
- [`StreamWriter::process`](https://auscaster.com/icey/docs/api-reference/icy-StreamWriter.md#process-9)
- [`SyncPacketQueue::process`](https://auscaster.com/icey/docs/api-reference/icy-SyncPacketQueue.md#process-10)
- [`AsyncPacketQueue::process`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#process)
- [`AsyncPacketQueue::process`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#process)
- [`AsyncPacketQueue::process`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#process)
- [`AsyncPacketQueue::process`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#process)
- [`ChunkedAdapter::process`](https://auscaster.com/icey/docs/api-reference/icy-http-ChunkedAdapter.md#process-15)
- [`FrameNormalizer::process`](https://auscaster.com/icey/docs/api-reference/icy-vision-FrameNormalizer.md#process-19)
- [`FrameSampler::process`](https://auscaster.com/icey/docs/api-reference/icy-vision-FrameSampler.md#process-20)
- [`WebRtcTrackSender::process`](https://auscaster.com/icey/docs/api-reference/icy-wrtc-WebRtcTrackSender.md#process-22)

---

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

### accepts

`virtual` `inline`

```cpp
virtual inline bool accepts(IPacket *)
```

[Defined in src/base/include/icy/packetstream.h:133](https://github.com/auscaster/icey/blob/main/src/base/include/icy/packetstream.h#L133)

This method ensures compatibility with the given packet type. Return false to reject the packet.

#### Reimplemented by

- [`FrameNormalizer::accepts`](https://auscaster.com/icey/docs/api-reference/icy-vision-FrameNormalizer.md#accepts-6)
- [`FrameSampler::accepts`](https://auscaster.com/icey/docs/api-reference/icy-vision-FrameSampler.md#accepts-7)
- [`AudioPacketEncoder::accepts`](https://auscaster.com/icey/docs/api-reference/icy-av-AudioPacketEncoder.md#accepts-3)
- [`MultiplexPacketEncoder::accepts`](https://auscaster.com/icey/docs/api-reference/icy-av-MultiplexPacketEncoder.md#accepts-5)
- [`VideoPacketEncoder::accepts`](https://auscaster.com/icey/docs/api-reference/icy-av-VideoPacketEncoder.md#accepts-4)
- [`SyncPacketQueue::accepts`](https://auscaster.com/icey/docs/api-reference/icy-SyncPacketQueue.md#accepts-2)
- [`AsyncPacketQueue::accepts`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#accepts)
- [`AsyncPacketQueue::accepts`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#accepts)
- [`AsyncPacketQueue::accepts`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#accepts)
- [`AsyncPacketQueue::accepts`](https://auscaster.com/icey/docs/api-reference/icy-AsyncPacketQueue.md#accepts)
- [`WebRtcTrackSender::accepts`](https://auscaster.com/icey/docs/api-reference/icy-wrtc-WebRtcTrackSender.md#accepts-8)

---

<a id="operator-69"></a>

### operator<<

`virtual` `inline`

```cpp
virtual inline void operator<<(IPacket & packet)
```

[Defined in src/base/include/icy/packetstream.h:136](https://github.com/auscaster/icey/blob/main/src/base/include/icy/packetstream.h#L136)

[Stream](https://auscaster.com/icey/docs/api-reference/icy-Stream.md#stream) operator alias for [process()](#process-1)