AV module
ICapture
Abstract interface for audio and video capture devices.
#include <icy/av/icapture.h>
class ICaptureDefined in src/av/include/icy/av/icapture.h:31
- Inherits
PacketStreamAdapter,Startable- Subclassed by
MediaCapture
List of all members
| Name | Kind | Owner |
|---|---|---|
emitter | variable | Declared here |
ICapture | function | Declared here |
~ICapture | function | Declared here |
start | function | Declared here |
stop | function | Declared here |
openFile | function | Declared here |
close | function | Declared here |
getEncoderFormat | function | Declared here |
getEncoderAudioCodec | function | Declared here |
getEncoderVideoCodec | function | Declared here |
openAudio | function | Declared here |
openVideo | function | Declared here |
onStreamStateChange | function | Declared here |
openStream | function | Declared here |
PacketStreamAdapter | function | Inherited from PacketStreamAdapter |
~PacketStreamAdapter | function | Inherited from PacketStreamAdapter |
emit | function | Inherited from PacketStreamAdapter |
emit | function | Inherited from PacketStreamAdapter |
emit | function | Inherited from PacketStreamAdapter |
emit | function | Inherited from PacketStreamAdapter |
emit | function | Inherited from PacketStreamAdapter |
getEmitter | function | Inherited from PacketStreamAdapter |
retention | function | Inherited from PacketStreamAdapter |
onStreamStateChange | function | Inherited from PacketStreamAdapter |
_emitter | variable | Inherited from PacketStreamAdapter |
PacketStreamAdapter | function | Inherited from PacketStreamAdapter |
operator= | function | Inherited from PacketStreamAdapter |
PacketStreamAdapter | function | Inherited from PacketStreamAdapter |
operator= | function | Inherited from PacketStreamAdapter |
start | function | Inherited from Startable |
stop | function | Inherited from Startable |
Inherited from PacketStreamAdapter
| Kind | Name | Description |
|---|---|---|
function | PacketStreamAdapter | Construct the adapter, binding it to the given packet signal. |
function | ~PacketStreamAdapter virtual inline | |
function | emit virtual | Emit a mutable raw buffer as a packet. |
function | emit virtual | Emit a read-only raw buffer as a packet (data is copied internally). |
function | emit virtual | Emit a string as a packet (data is copied internally). |
function | emit virtual | Emit a flag-only packet carrying no payload data. |
function | emit virtual | Emit an existing packet directly onto the outgoing signal. |
function | getEmitter | Returns a reference to the outgoing packet signal. |
function | retention 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 virtual inline | Called by the PacketStream to notify when the internal 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 | |
function | PacketStreamAdapter | NonCopyable and NonMovable. |
function | operator= | Deleted assignment operator. |
function | PacketStreamAdapter | Deleted constructor. |
function | operator= | Deleted assignment operator. |
Inherited from Startable
| Kind | Name | Description |
|---|---|---|
function | start virtual | Starts the object (e.g. begins processing or listening). |
function | stop virtual | Stops the object (e.g. halts processing or closes resources). |
Public Attributes
| Return | Name | Description |
|---|---|---|
PacketSignal | emitter |
emitter
PacketSignal emitterType: PacketSignal
Defined in src/av/include/icy/av/icapture.h:89
Public Methods
| Return | Name | Description |
|---|---|---|
ICapture inline | ||
~ICapture virtual | Defaulted destructor. | |
void | start virtual override | Start capturing and emitting packets. |
void | stop virtual override | Stop capturing and release device resources. |
void | openFile virtual inline | Open a media file as the capture source. |
void | close virtual inline | Release the capture source and any associated resources. |
void | getEncoderFormat virtual | Populate iformat with the encoder-ready format derived from this capture source. |
void | getEncoderAudioCodec virtual inline | Populate params with the encoder-ready audio codec parameters. |
void | getEncoderVideoCodec virtual inline | Populate params with the encoder-ready video codec parameters. |
void | openAudio virtual inline | Open an audio capture device with the given parameters. |
void | openVideo virtual inline | Open a video capture device with the given parameters. |
void | onStreamStateChange virtual inline override | React to PacketStream state transitions by starting or stopping capture. |
ICapture
inline
inline ICapture()Defined in src/av/include/icy/av/icapture.h:35
~ICapture
virtual
virtual ~ICapture() = defaultDefined in src/av/include/icy/av/icapture.h:39
Defaulted destructor.
start
virtual override
virtual void start() overrideDefined in src/av/include/icy/av/icapture.h:42
Start capturing and emitting packets.
Reimplements
Reimplemented by
stop
virtual override
virtual void stop() overrideDefined in src/av/include/icy/av/icapture.h:45
Stop capturing and release device resources.
Reimplements
Reimplemented by
openFile
virtual inline
virtual inline void openFile(const std::string & file)Defined in src/av/include/icy/av/icapture.h:49
Open a media file as the capture source.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
file | const std::string & | Path to the media file. |
close
virtual inline
virtual inline void close()Defined in src/av/include/icy/av/icapture.h:52
Release the capture source and any associated resources.
Reimplemented by
getEncoderFormat
virtual
virtual void getEncoderFormat(Format & iformat)Defined in src/av/include/icy/av/icapture.h:56
Populate iformat with the encoder-ready format derived from this capture source.
Reimplemented by
Parameters
getEncoderAudioCodec
virtual inline
virtual inline void getEncoderAudioCodec(AudioCodec & params)Defined in src/av/include/icy/av/icapture.h:60
Populate params with the encoder-ready audio codec parameters.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
params | AudioCodec & | Output AudioCodec struct to fill. |
getEncoderVideoCodec
virtual inline
virtual inline void getEncoderVideoCodec(VideoCodec & params)Defined in src/av/include/icy/av/icapture.h:64
Populate params with the encoder-ready video codec parameters.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
params | VideoCodec & | Output VideoCodec struct to fill. |
openAudio
virtual inline
virtual inline void openAudio(const std::string & device, const AudioCodec & params)Defined in src/av/include/icy/av/icapture.h:69
Open an audio capture device with the given parameters.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
device | const std::string & | The platform audio device identifier. |
params | const AudioCodec & | The desired capture parameters. |
openVideo
virtual inline
virtual inline void openVideo(const std::string & device, const VideoCodec & params)Defined in src/av/include/icy/av/icapture.h:74
Open a video capture device with the given parameters.
Reimplemented by
Parameters
| Parameter | Type | Description |
|---|---|---|
device | const std::string & | The platform video device identifier. |
params | const VideoCodec & | The desired capture parameters. |
onStreamStateChange
virtual inline override
virtual inline void onStreamStateChange(const PacketStreamState & state) overrideDefined in src/av/include/icy/av/icapture.h:77
React to PacketStream state transitions by starting or stopping capture.
Reimplements
Protected Methods
| Return | Name | Description |
|---|---|---|
void | openStream virtual inline |
openStream
virtual inline
virtual inline void openStream(const std::string & filename, const AVInputFormat * inputFormat, AVDictionary ** formatParams)Defined in src/av/include/icy/av/icapture.h:92