All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
AVDeviceCapabilitiesQuery Struct Reference

Following API allows user to probe device capabilities (supported codecs, pixel formats, sample formats, resolutions, channel counts, etc). More...

#include <avdevice.h>

Data Fields

const AVClassav_class
enum AVCodecID codec
enum AVSampleFormat sample_format
enum AVPixelFormat pixel_format
int sample_rate
int channels
int64_t channel_layout
int window_width
int window_height
int frame_width
int frame_height
AVRational fps

Detailed Description

Following API allows user to probe device capabilities (supported codecs, pixel formats, sample formats, resolutions, channel counts, etc).

It is build on top op AVOption API. Queried capabilities make it possible to set up converters of video or audio parameters that fit to the device.

List of capabilities that can be queried:

Value of the capability may be set by user using av_opt_set() function and AVDeviceCapabilitiesQuery object. Following queries will limit results to the values matching already set capabilities. For example, setting a codec may impact number of formats or fps values returned during next query. Setting invalid value may limit results to zero.

Example of the usage basing on opengl output device:

AVOptionRanges *ranges;
int ret;
if ((ret = avformat_alloc_output_context2(&oc, NULL, "opengl", NULL)) < 0)
goto fail;
if (avdevice_capabilities_create(&caps, oc, NULL) < 0)
goto fail;
//query codecs
if (av_opt_query_ranges(&ranges, caps, "codec", AV_OPT_MULTI_COMPONENT_RANGE)) < 0)
goto fail;
//pick codec here and set it
av_opt_set(caps, "codec", AV_CODEC_ID_RAWVIDEO, 0);
//query format
if (av_opt_query_ranges(&ranges, caps, "pixel_format", AV_OPT_MULTI_COMPONENT_RANGE)) < 0)
goto fail;
//pick format here and set it
av_opt_set(caps, "pixel_format", AV_PIX_FMT_YUV420P, 0);
//query and set more capabilities
//clean up code

Structure describes device capabilities.

It is used by devices in conjunction with av_device_capabilities AVOption table to implement capabilities probing API based on AVOption API. Should not be used directly.

Definition at line 428 of file avdevice.h.

Field Documentation

const AVClass* AVDeviceCapabilitiesQuery::av_class

Definition at line 429 of file avdevice.h.

AVFormatContext* AVDeviceCapabilitiesQuery::device_context

Definition at line 430 of file avdevice.h.

enum AVCodecID AVDeviceCapabilitiesQuery::codec

Definition at line 431 of file avdevice.h.

enum AVSampleFormat AVDeviceCapabilitiesQuery::sample_format

Definition at line 432 of file avdevice.h.

enum AVPixelFormat AVDeviceCapabilitiesQuery::pixel_format

Definition at line 433 of file avdevice.h.

int AVDeviceCapabilitiesQuery::sample_rate

Definition at line 434 of file avdevice.h.

int AVDeviceCapabilitiesQuery::channels

Definition at line 435 of file avdevice.h.

int64_t AVDeviceCapabilitiesQuery::channel_layout

Definition at line 436 of file avdevice.h.

int AVDeviceCapabilitiesQuery::window_width

Definition at line 437 of file avdevice.h.

int AVDeviceCapabilitiesQuery::window_height

Definition at line 438 of file avdevice.h.

int AVDeviceCapabilitiesQuery::frame_width

Definition at line 439 of file avdevice.h.

int AVDeviceCapabilitiesQuery::frame_height

Definition at line 440 of file avdevice.h.

AVRational AVDeviceCapabilitiesQuery::fps

Definition at line 441 of file avdevice.h.

The documentation for this struct was generated from the following file: