Ffmpeg The Third

https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/
Admin
Ffmpeg The Third is a Rust binding for the FFmpeg multimedia framework, providing access to its...
Tokens:58,566
Snippets:680
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get logging flags

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/log/fn.get_flags.html

Retrieves the current logging configuration flags.

```rust
pub fn get_flags() -> Flags
```

--------------------------------

### output_as_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_as_with.html

Initializes an output format context for a given path or URL with specific format and options.

```APIDOC
## Function: output_as_with

### Description
Initializes an output format context using the provided path or URL, format, and dictionary options.

### Signature
`pub fn output_as_with<P, Dict>(path_or_url: P, format: &str, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or URL for the output.
- **format** (&str) - The format string to use for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to apply to the output format.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### get(&self) -> &str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/subtitle/struct.AssMut.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the current subtitle text content.

```APIDOC
### pub fn get(&self) -> &str

Returns the current text content of the subtitle rectangle.
```

--------------------------------

### output_as

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_as.html

Initializes an output context with a specified path or URL and format.

```APIDOC
## fn output_as

### Description
Initializes an FFmpeg output context using the provided path or URL and the specified format string.

### Signature
`pub fn output_as<P: AsRef<OsStr>>(path_or_url: P, format: &str) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - Required - The file path or URL for the output.
- **format** (&str) - Required - The format string (e.g., "mp4", "mkv").

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### Initialize output format context

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output.html

Creates an Output instance from a specified file path or URL string.

```rust
pub fn output<P: AsRef<OsStr>>(path_or_url: P) -> Result<Output, Error>
```

--------------------------------

### get

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/dictionary/struct.DictionaryRef.html

Finds a value in the dictionary using case-insensitive matching for the provided key.

```APIDOC
## pub fn get<K: AsRef<str>>(&self, key: K) -> Option<&str>

### Description
Try to find a value in the dictionary. This function uses case-insensitive matching of the entire key string to find a value.
```

--------------------------------

### pub fn get(&self) -> &str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/subtitle/struct.Text.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the subtitle text content as a string slice.

```APIDOC
### Method
`get(&self) -> &str`

### Description
Returns the subtitle text contained within the Text struct as a string slice.

### Returns
- **&str** - The subtitle text content.
```

--------------------------------

### output_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_with.html?search=std%3A%3Avec

Initializes an output context for FFmpeg using a path or URL and a set of options.

```APIDOC
## Function: output_with

### Description
Initializes an output context for FFmpeg. This function takes a path or URL and a set of options to configure the output.

### Signature
`pub fn output_with<P, Dict>(path_or_url: P, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or URL for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to apply to the output context.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### Get current time signature

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/time/fn.current.html?search=

Displays the function signature for retrieving the current time as an i64 integer.

```rust
pub fn current() -> i64
```

--------------------------------

### output_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_with.html

Initializes an FFmpeg output context with a given path or URL and configuration options.

```APIDOC
## fn output_with

### Description
Initializes an output context for FFmpeg. This function takes a path or URL and a set of options to configure the output stream.

### Signature
`pub fn output_with<P, Dict>(path_or_url: P, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The destination path or URL for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to apply to the output context.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### output_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_with.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes an output context for FFmpeg using the provided path or URL and configuration options.

```APIDOC
## Function: output_with

### Description
Initializes an output context for FFmpeg. This function takes a path or URL and a set of options to configure the output.

### Signature
`pub fn output_with<P, Dict>(path_or_url: P, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or URL for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of FFmpeg options to apply to the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### output_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_with.html?search=u32+-%3E+bool

Initializes an output context for FFmpeg with a given path or URL and configuration options.

```APIDOC
## Function: output_with

### Description
Initializes an output context for FFmpeg operations. This function takes a path or URL and a set of dictionary options to configure the output.

### Signature
`pub fn output_with<P, Dict>(path_or_url: P, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or URL for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - The dictionary options to apply to the output context.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### output_as_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_as_with.html?search=

Initializes an FFmpeg output context with a specified path, format, and dictionary of options.

```APIDOC
## Function: output_as_with

### Description
Initializes an FFmpeg output context using the provided path or URL, format string, and a dictionary of options.

### Signature
`pub fn output_as_with<P, Dict>(path_or_url: P, format: &str, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The destination path or URL for the output.
- **format** (&str) - The format name to be used for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to configure the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### init()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/network/fn.init.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes the network module for ffmpeg-the-third.

```APIDOC
## Function: init

### Description
Initializes the network components required by the ffmpeg-the-third library.

### Signature
`pub fn init()`
```

--------------------------------

### output_as_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_as_with.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes an output context for FFmpeg operations using a path or URL, a format string, and a dictionary of options.

```APIDOC
## Function: output_as_with

### Description
Initializes an output context for FFmpeg, allowing for the specification of a destination path or URL, the desired format, and additional configuration options via a dictionary.

### Signature
`pub fn output_as_with<P, Dict>(path_or_url: P, format: &str, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The destination path or URL for the output.
- **format** (&str) - The format string to be used for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to configure the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### init

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/network/index.html

Initializes the network components required by the library.

```APIDOC
## init

### Description
Initializes the network components for the ffmpeg_the_third library.

### Signature
`pub fn init()`
```

--------------------------------

### output_as

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_as.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes an FFmpeg output context with a specified path and format.

```APIDOC
## Function: output_as

### Description
Initializes an output context for FFmpeg using the provided path or URL and the specified format string.

### Signature
`pub fn output_as<P: AsRef<OsStr>>(path_or_url: P, format: &str) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or network URL for the output.
- **format** (&str) - The format string (e.g., "mp4", "mkv") to use for the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### fn init

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/network/fn.init.html?search=

Initializes the network subsystem for FFmpeg.

```APIDOC
## Function: init

### Description
Initializes the network subsystem. This function should be called before using network-related features in the library.

### Signature
`pub fn init()`
```

--------------------------------

### pub fn init()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/network/fn.init.html

Initializes the network subsystem for the ffmpeg-the-third library. This function should be called to prepare network-related functionality.

```APIDOC
## Function: init

### Description
Initializes the network subsystem for the ffmpeg-the-third library.

### Signature
`pub fn init()`
```

--------------------------------

### fn init()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/fn.init.html

Initializes the FFmpeg library environment. This function should be called before using other features of the crate.

```APIDOC
## fn init()

### Description
Initializes the underlying FFmpeg libraries. This must be called to prepare the environment for subsequent operations.

### Signature
`pub fn init() -> Result<(), Error>`

### Returns
- **Result<(), Error>** - Returns `Ok(())` on success, or an `Error` if the initialization fails.
```

--------------------------------

### ffmpeg_the_third::format::output_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_with.html?search=

Initializes an output context for FFmpeg with the provided path or URL and dictionary options.

```APIDOC
## Function: output_with

### Description
Initializes an FFmpeg output context using the provided path or URL and a set of options.

### Signature
`pub fn output_with<P, Dict>(path_or_url: P, options: Dict) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or URL for the output.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to configure the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the initialization fails.
```

--------------------------------

### output_as<P: AsRef<OsStr>>(path_or_url: P, format: &str) -> Result<Output, Error>

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output_as.html?search=std%3A%3Avec

Initializes an output destination with a specified format.

```APIDOC
## Function: output_as

### Description
Creates an output configuration for FFmpeg by specifying the target path or URL and the desired format.

### Signature
`pub fn output_as<P: AsRef<OsStr>>(path_or_url: P, format: &str) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The destination path or URL for the output.
- **format** (&str) - The format string to be used for the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the operation fails.
```

--------------------------------

### pub fn init() -> Result<(), Error>

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/fn.init.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes the ffmpeg-the-third library. This function should be called before using other library features.

```APIDOC
## Function: init

### Description
Initializes the ffmpeg-the-third library. This function must be called to set up the environment for subsequent library operations.

### Signature
`pub fn init() -> Result<(), Error>`

### Returns
- **Result<(), Error>** - Returns `Ok(())` on success, or an `Error` if initialization fails.
```

--------------------------------

### fn init

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/fn.init.html?search=u32+-%3E+bool

Initializes the ffmpeg_the_third library.

```APIDOC
## fn init

### Description
Initializes the ffmpeg_the_third library. This function should be called before using other library features.

### Signature
`pub fn init() -> Result<(), Error>`

### Returns
- **Result<(), Error>** - Returns Ok(()) on success, or an Error if initialization fails.
```

--------------------------------

### Initialize network components

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/network/fn.init.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes the network subsystem for ffmpeg-the-third.

```rust
pub fn init()
```

--------------------------------

### pub fn configuration() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/scaling/fn.configuration.html

Retrieves the current scaling configuration as a static string slice.

```APIDOC
## Function: configuration

### Description
Returns the scaling configuration as a static string slice. This function is part of the `ffmpeg_the_third::software::scaling` module.

### Signature
`pub fn configuration() -> &'static str`

### Returns
- **&'static str**: The configuration string.
```

--------------------------------

### ChannelLayoutIter::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/channel_layout/struct.ChannelLayoutIter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of ChannelLayoutIter.

```APIDOC
## pub const fn new() -> Self

### Description
Creates a new instance of the ChannelLayoutIter struct.

### Signature
`pub const fn new() -> Self`
```

--------------------------------

### fn init()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/fn.init.html?search=std%3A%3Avec

Initializes the ffmpeg_the_third library. This function must be called before using other library features.

```APIDOC
## fn init()

### Description
Initializes the ffmpeg_the_third library. Returns a Result indicating success or an Error if initialization fails.

### Signature
`pub fn init() -> Result<(), Error>`
```

--------------------------------

### configuration()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/fn.configuration.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the FFmpeg build configuration string.

```APIDOC
## Function: configuration

### Description
Returns the static string containing the configuration parameters used to build the underlying FFmpeg library.

### Signature
`pub fn configuration() -> &'static str`

### Returns
- **&'static str** - A string slice containing the FFmpeg configuration details.
```

--------------------------------

### fn output

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output.html?search=std%3A%3Avec

Initializes an output context for a specified path or URL.

```APIDOC
## fn output

### Description
Creates an output context for the provided path or URL, returning an `Output` object or an `Error` if the operation fails.

### Signature
`pub fn output<P: AsRef<OsStr>>(path_or_url: P) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - Required - The file path or URL to be used for the output.

### Returns
- **Result<Output, Error>** - Returns an `Output` instance on success, or an `Error` if the initialization fails.
```

--------------------------------

### Initialize FFmpeg library

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/fn.init.html

Call this function to initialize the underlying FFmpeg library. It returns an Error if initialization fails.

```rust
pub fn init() -> Result<(), Error>
```

--------------------------------

### pub fn new() -> Decoder

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/decoder/fn.new.html

Initializes a new instance of the Decoder.

```APIDOC
## Function: new

### Description
Creates and returns a new instance of the `Decoder` struct.

### Signature
`pub fn new() -> Decoder`
```

--------------------------------

### pub fn input<P: AsRef<OsStr>>(path_or_url: P) -> Result<Input, Error>

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.input.html?search=

Opens a media input from a given path or URL.

```APIDOC
## Function: input

### Description
Opens a media file or URL and returns an `Input` object for further processing.

### Signature
`pub fn input<P: AsRef<OsStr>>(path_or_url: P) -> Result<Input, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The file path or URL string to open.

### Returns
- **Result<Input, Error>** - Returns an `Input` instance on success, or an `Error` if the input could not be opened.
```

--------------------------------

### pub fn configuration() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/resampling/fn.configuration.html

Retrieves the configuration string for the resampling software component.

```APIDOC
## configuration

### Description
Returns the configuration of the resampling software as a static string.

### Signature
`pub fn configuration() -> &'static str`

### Returns
- **&'static str**: The configuration string.
```

--------------------------------

### PadIter::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/filter/filter/struct.PadIter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of PadIter.

```APIDOC
## pub fn new(ptr: *const AVFilterPad, count: isize) -> Self

### Description
Constructs a new PadIter instance using a pointer to an AVFilterPad and the count of elements.

### Parameters
- **ptr** (*const AVFilterPad) - Pointer to the start of the AVFilterPad array.
- **count** (isize) - The number of elements in the array.
```

--------------------------------

### fn configuration

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/scaling/fn.configuration.html?search=

Retrieves the software scaling configuration as a static string.

```APIDOC
## fn configuration

### Description
Returns the configuration string for the software scaling component.

### Signature
`pub fn configuration() -> &'static str`
```

--------------------------------

### pub fn output<P: AsRef<OsStr>>(path_or_url: P) -> Result<Output, Error>

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output.html

Initializes an output format context for the specified path or URL. Returns an Output object on success or an Error if the operation fails.

```APIDOC
## Function: output

### Description
Initializes an output format context for a given path or URL.

### Signature
`pub fn output<P: AsRef<OsStr>>(path_or_url: P) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - Required - The file path or URL to be used for the output format context.

### Returns
- **Result<Output, Error>** - Returns an `Output` instance on success, or an `Error` if the initialization fails.
```

--------------------------------

### ProfileIter::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/profile/struct.ProfileIter.html?search=std%3A%3Avec

Creates a new instance of ProfileIter.

```APIDOC
## pub fn new(id: Id, ptr: *const AVProfile) -> Self

### Description
Creates a new ProfileIter instance using the provided identifier and a raw pointer to an AVProfile structure.
```

--------------------------------

### ffmpeg_the_third::format::output

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.output.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes an output context for the specified path or URL.

```APIDOC
## Function: output

### Description
Creates an output context for a given file path or URL. This is used to prepare for writing media data.

### Signature
`pub fn output<P: AsRef<OsStr>>(path_or_url: P) -> Result<Output, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - Required - The file path or URL to open for output.

### Returns
- **Result<Output, Error>** - Returns an `Output` object on success, or an `Error` if the operation fails.
```

--------------------------------

### PacketIter::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/context/input/struct.PacketIter.html

Creates a new PacketIter instance from a mutable reference to an Input context.

```APIDOC
## fn new(context: &mut Input) -> PacketIter<'_>

### Description
Creates a new iterator that yields packets from the provided input context.

### Parameters
- **context** (&mut Input) - Required - A mutable reference to the input context from which packets will be read.
```

--------------------------------

### ChannelLayoutIter Creation and Selection

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/codec/struct.ChannelLayoutIter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to initialize the iterator from a raw pointer and to select the best layout.

```rust
pub unsafe fn from_raw(ptr: *const AVChannelLayout) -> Option<Self>
```

```rust
pub fn best(self, max: u32) -> ChannelLayout<'a>
```

--------------------------------

### Context::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/context/struct.Context.html?search=std%3A%3Avec

Creates a new, empty codec context.

```APIDOC
### pub fn new() -> Self

Creates a new instance of `Context`.
```

--------------------------------

### fn configuration

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/fn.configuration.html

Returns the configuration string used to build the FFmpeg library.

```APIDOC
## fn configuration

### Description
Returns the configuration string that was used to build the underlying FFmpeg library. This is useful for identifying the features and build options enabled in the linked FFmpeg instance.

### Signature
`pub fn configuration() -> &'static str`

### Returns
- **&'static str** - The configuration string of the FFmpeg library.
```

--------------------------------

### Context::run

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/scaling/context/struct.Context.html

Executes the scaling operation using the current context.

```APIDOC
## fn run(&mut self, input: &Video, output: &mut Video) -> Result<(), Error>

### Description
Performs the scaling operation from the input video frame to the output video frame using the configured context.

### Parameters
- **input** (&Video) - The source video frame
- **output** (&mut Video) - The destination video frame

### Returns
- **Result<(), Error>** - Returns Ok(()) on success, or an Error if the operation fails.
```

--------------------------------

### configuration()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/scaling/fn.configuration.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the static configuration string used by the software scaling module.

```APIDOC
## Function: configuration

### Description
Returns the static configuration string for the software scaling module.

### Signature
`pub fn configuration() -> &'static str`

### Returns
- **&'static str** - The static configuration string.
```

--------------------------------

### Ass::as_ptr

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/subtitle/struct.Ass.html?search=std%3A%3Avec

Returns the raw pointer to the underlying AVSubtitleRect.

```APIDOC
## pub unsafe fn as_ptr(&self) -> *const AVSubtitleRect

### Description
Retrieves the raw pointer to the underlying AVSubtitleRect structure managed by this instance.
```

--------------------------------

### Context::run

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/resampling/context/struct.Context.html?search=

Processes audio data through the resampler from the input buffer to the output buffer.

```APIDOC
## pub fn run(&mut self, input: &Audio, output: &mut Audio) -> Result<Option<Delay>, Error>

### Description
Run the resampler from the given input to the given output. When there are internal frames to process it will return `Ok(Some(Delay { .. }))`.
```

--------------------------------

### Initialize audio resampler context

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.resampler.html

Defines the signature for creating a resampling context between two audio configurations.

```rust
pub fn resampler(
    (in_format, in_layout, in_rate): (Sample, ChannelLayoutMask, u32),
    (out_format, out_layout, out_rate): (Sample, ChannelLayoutMask, u32),
) -> Result<Context, Error>
```

--------------------------------

### Retrieve FFmpeg configuration

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/fn.configuration.html

Returns the static configuration string for the underlying FFmpeg library.

```rust
pub fn configuration() -> &'static str
```

--------------------------------

### Context::new_with_codec

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/context/struct.Context.html?search=std%3A%3Avec

Creates a new codec context initialized with a specific codec.

```APIDOC
### pub fn new_with_codec(codec: Codec) -> Self

Creates a new `Context` initialized with the provided `Codec`.
```

--------------------------------

### register_all()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/fn.register_all.html

Registers all available devices within the ffmpeg_the_third library.

```APIDOC
## register_all

### Description
Registers all available devices. This function is part of the `ffmpeg_the_third::device` module.

### Signature
`pub fn register_all()`
```

--------------------------------

### ChannelLayoutIter Initialization

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/codec/struct.ChannelLayoutIter.html?search=u32+-%3E+bool

Creates a new iterator from a raw FFmpeg channel layout pointer.

```rust
pub unsafe fn from_raw(ptr: *const AVChannelLayout) -> Option<Self>
```

--------------------------------

### from_raw

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/codec/struct.ChannelLayoutIter.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new ChannelLayoutIter from a raw pointer to an AVChannelLayout.

```APIDOC
### pub unsafe fn from_raw(ptr: *const AVChannelLayout) -> Option<Self>

Creates a new `ChannelLayoutIter` instance from a raw pointer. This is an unsafe operation as it relies on the validity of the provided pointer.
```

--------------------------------

### Context configuration methods

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/filter/context/struct.Context.html?search=std%3A%3Avec

Methods for configuring filter sources, sinks, and properties.

```rust
pub fn source(&'a mut self) -> Source<'a>
```

```rust
pub fn sink(&'a mut self) -> Sink<'a>
```

```rust
pub fn set_pixel_format(&mut self, value: Pixel)
```

```rust
pub fn set_sample_format(&mut self, value: Sample)
```

```rust
pub fn set_sample_rate(&mut self, value: u32)
```

```rust
pub fn set_channel_layout(&mut self, value: ChannelLayoutMask)
```

```rust
pub fn set_ch_layout(&mut self, value: ChannelLayout<'_>)
```

--------------------------------

### fn configuration

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/fn.configuration.html?search=

Retrieves the configuration string for the FFmpeg device.

```APIDOC
## fn configuration

### Description
Returns the configuration of the FFmpeg device as a static string.

### Signature
`pub fn configuration() -> &'static str`
```

--------------------------------

### Context Configuration Methods

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/encoder/video/struct.Encoder.html?search=u32+-%3E+bool

Methods inherited from the Context struct for low-level codec configuration.

```APIDOC
## pub fn codec(&self) -> Option<Codec>

## pub fn medium(&self) -> Type

## pub fn set_flags(&mut self, value: Flags)

## pub fn id(&self) -> Id

## pub fn compliance(&mut self, value: Compliance)

## pub fn debug(&mut self, value: Debug)

## pub fn set_threading(&mut self, config: Config)

## pub fn threading(&self) -> Config

## pub fn set_parameters<P: AsPtr<AVCodecParameters>>( &mut self, parameters: P, ) -> Result<(), Error>
```

--------------------------------

### Audio Encoder Methods

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/encoder/audio/struct.Audio.html?search=

Methods for initializing the audio encoder and configuring audio properties.

```APIDOC
## pub fn open(self) -> Result<Encoder, Error>
Opens the audio encoder.

## pub fn open_as<T, Enc>(self, codec: Enc) -> Result<Encoder, Error>
Opens the audio encoder with a specific codec.

## pub fn open_with<Dict>(self, options: Dict) -> Result<Encoder, Error>
Opens the audio encoder with provided dictionary options.

## pub fn set_rate(&mut self, rate: i32)
Sets the audio sample rate.

## pub fn set_format(&mut self, value: Sample)
Sets the audio sample format.

## pub fn set_channels(&mut self, value: i32)
Sets the number of audio channels.
```

--------------------------------

### pub fn license() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/fn.license.html?search=u32+-%3E+bool

Retrieves the license information for the codec module as a static string.

```APIDOC
## Function: license

### Description
Returns the license information for the codec module.

### Signature
`pub fn license() -> &'static str`

### Returns
- **&'static str** - The license string.
```

--------------------------------

### DeviceIter::wrap

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/extensions/struct.DeviceIter.html?search=u32+-%3E+bool

Creates a new DeviceIter instance from a raw AVFormatContext pointer.

```APIDOC
## pub unsafe fn wrap(ctx: *const AVFormatContext) -> Result<Self, Error>

### Description
Creates a new DeviceIter instance by wrapping a raw pointer to an AVFormatContext. This method is unsafe as it relies on the validity of the provided pointer.

### Parameters
- **ctx** (*const AVFormatContext) - Required - A raw pointer to the FFmpeg format context.

### Returns
- **Result<Self, Error>** - Returns a new DeviceIter instance on success, or an Error if the operation fails.
```

--------------------------------

### pub fn resampler

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.resampler.html

Initializes a new audio resampling context based on the provided input and output configurations.

```APIDOC
## Function: resampler

### Description
Creates a new resampling context for audio processing. It requires defining the input and output sample formats, channel layouts, and sample rates.

### Signature
`pub fn resampler((in_format, in_layout, in_rate): (Sample, ChannelLayoutMask, u32), (out_format, out_layout, out_rate): (Sample, ChannelLayoutMask, u32)) -> Result<Context, Error>`

### Parameters
- **in_format** (Sample) - The input sample format.
- **in_layout** (ChannelLayoutMask) - The input channel layout.
- **in_rate** (u32) - The input sample rate.
- **out_format** (Sample) - The output sample format.
- **out_layout** (ChannelLayoutMask) - The output channel layout.
- **out_rate** (u32) - The output sample rate.

### Returns
- **Result<Context, Error>** - Returns a Result containing the resampling Context on success, or an Error if initialization fails.
```

--------------------------------

### Context::get

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/scaling/context/struct.Context.html

Creates a new scaling context with the specified source and destination parameters.

```APIDOC
## fn get(src_format: Pixel, src_w: u32, src_h: u32, dst_format: Pixel, dst_w: u32, dst_h: u32, flags: Flags) -> Result<Self, Error>

### Description
Initializes a new scaling context based on the provided source and destination pixel formats, dimensions, and scaling flags.

### Parameters
- **src_format** (Pixel) - Source pixel format
- **src_w** (u32) - Source width
- **src_h** (u32) - Source height
- **dst_format** (Pixel) - Destination pixel format
- **dst_w** (u32) - Destination width
- **dst_h** (u32) - Destination height
- **flags** (Flags) - Scaling algorithm flags

### Returns
- **Result<Self, Error>** - A new Context instance or an error if initialization fails.
```

--------------------------------

### fn resampler2

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.resampler2.html?search=

Initializes a new resampling context with the provided input and output audio parameters.

```APIDOC
## fn resampler2

### Signature
`pub fn resampler2((in_format, in_layout, in_rate): (Sample, ChannelLayout<'_>, u32), (out_format, out_layout, out_rate): (Sample, ChannelLayout<'_>, u32)) -> Result<Context, Error>`

### Description
Creates a new resampling context for converting audio between specified input and output configurations.

### Parameters
- **in_format** (Sample) - The input audio sample format.
- **in_layout** (ChannelLayout) - The input channel layout.
- **in_rate** (u32) - The input sample rate.
- **out_format** (Sample) - The output audio sample format.
- **out_layout** (ChannelLayout) - The output channel layout.
- **out_rate** (u32) - The output sample rate.

### Returns
- **Result<Context, Error>** - Returns a Result containing the resampling Context on success, or an Error if initialization fails.
```

--------------------------------

### pub fn license() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/filter/fn.license.html?search=u32+-%3E+bool

Retrieves the license information for the ffmpeg_the_third crate as a static string.

```APIDOC
## Function: license

### Description
Returns the license information for the library as a static string.

### Signature
`pub fn license() -> &'static str`

### Returns
- **&'static str** - The license string.
```

--------------------------------

### fn resampler

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.resampler.html?search=

Initializes a new resampling context with the provided input and output audio parameters.

```APIDOC
## fn resampler

### Description
Creates a new resampling context for converting audio between specified input and output configurations.

### Signature
`pub fn resampler((in_format, in_layout, in_rate): (Sample, ChannelLayoutMask, u32), (out_format, out_layout, out_rate): (Sample, ChannelLayoutMask, u32)) -> Result<Context, Error>`

### Parameters
- **in_format** (Sample) - Input sample format
- **in_layout** (ChannelLayoutMask) - Input channel layout
- **in_rate** (u32) - Input sample rate
- **out_format** (Sample) - Output sample format
- **out_layout** (ChannelLayoutMask) - Output channel layout
- **out_rate** (u32) - Output sample rate

### Returns
- **Result<Context, Error>** - Returns a Result containing the resampling Context on success, or an Error if initialization fails.
```

--------------------------------

### Subtitle::open_as_with

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/encoder/subtitle/struct.Subtitle.html

Opens the subtitle encoder with a specific codec and custom options.

```APIDOC
## pub fn open_as_with<T, Enc, Dict>(self, codec: Enc, options: Dict) -> Result<Encoder, Error>

### Description
Opens the subtitle encoder with a specific codec and a dictionary of options.

### Parameters
- **codec** (Enc) - The codec to use.
- **options** (Dict) - Configuration options for the encoder.
```

--------------------------------

### pub fn configuration() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/filter/fn.configuration.html?search=

Retrieves the configuration string for the filter module.

```APIDOC
## Function: configuration

### Description
Returns the configuration of the filter as a static string.

### Signature
`pub fn configuration() -> &'static str`
```

--------------------------------

### pub fn version() -> u32

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.version.html

Returns the version of the FFmpeg library currently in use by the crate.

```APIDOC
## Function: version

### Description
Returns the version of the underlying FFmpeg library as a `u32` integer.

### Signature
`pub fn version() -> u32`
```

--------------------------------

### pub fn video() -> VideoIter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/input/fn.video.html

Returns an iterator over the available video input devices.

```APIDOC
## Function: video

### Description
Returns an iterator (`VideoIter`) over the available video input devices supported by the system.

### Signature
`pub fn video() -> VideoIter`
```

--------------------------------

### Buffer::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/format/sample/struct.Buffer.html

Creates a new Buffer instance with the specified format, channel count, sample count, and alignment.

```APIDOC
## fn new(format: Sample, channels: u16, samples: usize, align: bool) -> Self

### Description
Creates a new `Buffer` instance based on the provided audio format, number of channels, number of samples, and alignment preference.

### Parameters
- **format** (Sample) - The format of the audio samples.
- **channels** (u16) - The number of audio channels.
- **samples** (usize) - The number of samples to allocate.
- **align** (bool) - Whether the buffer should be aligned.
```

--------------------------------

### from_raw

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/format/struct.Output.html?search=u32+-%3E+bool

Creates an Output instance from a raw pointer to an AVOutputFormat.

```APIDOC
pub unsafe fn from_raw(ptr: *const AVOutputFormat) -> Option<Self>
```

--------------------------------

### MuxerIter::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/format/struct.MuxerIter.html

Creates a new instance of MuxerIter.

```APIDOC
## pub fn new() -> Self

### Description
Creates a new instance of the MuxerIter struct.

### Signature
`pub fn new() -> Self`
```

--------------------------------

### FFI and Lifecycle Management

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/parameters/struct.Parameters.html?search=std%3A%3Avec

Methods for creating instances from raw pointers and exposing pointers for FFI usage.

```rust
pub unsafe fn from_raw(ptr: *mut AVCodecParameters) -> Option<Self>
```

```rust
pub fn as_ptr(&self) -> *const AVCodecParameters
```

```rust
pub fn as_mut_ptr(&mut self) -> *mut AVCodecParameters
```

```rust
pub fn new() -> Self
```

--------------------------------

### pub fn deinit()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/network/fn.deinit.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Deinitializes the network format module.

```APIDOC
## Function: deinit

### Description
Deinitializes the network format module in the ffmpeg_the_third crate.

### Signature
`pub fn deinit()`
```

--------------------------------

### description()

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/struct.Info.html

Retrieves the description of the device.

```APIDOC
### pub fn description(&self) -> &str

Returns the description of the device as a string slice.
```

--------------------------------

### fn license

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/scaling/fn.license.html

Retrieves the license information for the scaling component as a static string.

```APIDOC
## fn license

### Description
Returns the license information for the scaling component.

### Signature
`pub fn license() -> &'static str`

### Returns
- **&'static str** - The license string associated with the scaling software.
```

--------------------------------

### fn resampler

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.resampler.html?search=u32+-%3E+bool

Initializes a new resampling context with specified input and output audio parameters.

```APIDOC
## fn resampler

### Description
Creates a new `Context` for audio resampling by defining the input and output configurations.

### Signature
`pub fn resampler((in_format, in_layout, in_rate): (Sample, ChannelLayoutMask, u32), (out_format, out_layout, out_rate): (Sample, ChannelLayoutMask, u32)) -> Result<Context, Error>`

### Parameters
- **in_format** (Sample) - The input sample format.
- **in_layout** (ChannelLayoutMask) - The input channel layout.
- **in_rate** (u32) - The input sample rate.
- **out_format** (Sample) - The output sample format.
- **out_layout** (ChannelLayoutMask) - The output channel layout.
- **out_rate** (u32) - The output sample rate.

### Returns
- **Result<Context, Error>** - Returns a `Context` on success, or an `Error` if initialization fails.
```

--------------------------------

### Borrow::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/packet/borrow/struct.Borrow.html?search=u32+-%3E+bool

Creates a new Borrow instance from a byte slice.

```APIDOC
## pub fn new(data: &[u8]) -> Borrow<'_>

### Description
Creates a new `Borrow` instance that references the provided byte slice.

### Parameters
- **data** (&[u8]) - Required - The byte slice to be borrowed.
```

--------------------------------

### pub fn scaler

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.scaler.html?search=std%3A%3Avec

Initializes a new scaling context for video frames.

```APIDOC
## Function: scaler

### Signature
`pub fn scaler(format: Pixel, flags: Flags, (in_width, in_height): (u32, u32), (out_width, out_height): (u32, u32)) -> Result<Context, Error>`

### Description
Creates a new scaling context for converting video frames between different resolutions and pixel formats.

### Parameters
- **format** (Pixel) - The pixel format for the scaling operation.
- **flags** (Flags) - Scaling flags to configure the algorithm.
- **in_width** (u32) - The width of the input frame.
- **in_height** (u32) - The height of the input frame.
- **out_width** (u32) - The target width for the output frame.
- **out_height** (u32) - The target height for the output frame.

### Returns
- **Result<Context, Error>** - Returns a scaling Context on success, or an Error if initialization fails.
```

--------------------------------

### PadIter Constructor

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/filter/filter/struct.PadIter.html?search=

Creates a new instance of PadIter.

```rust
pub fn new(ptr: *const AVFilterPad, count: isize) -> Self
```

--------------------------------

### pub fn input<P: AsRef<OsStr>>(path_or_url: P) -> Result<Input, Error>

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.input.html

Opens an input source from a file path or URL. Returns an Input object on success or an Error if the operation fails.

```APIDOC
## Function: input

### Description
Opens a media input source, such as a file path or a URL, for use with FFmpeg.

### Signature
`pub fn input<P: AsRef<OsStr>>(path_or_url: P) -> Result<Input, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The path to the file or the URL of the stream to be opened.

### Returns
- **Result<Input, Error>** - Returns an `Input` instance on success, or an `Error` if the input could not be opened.
```

--------------------------------

### input_with_dictionary

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/fn.input_with_dictionary.html

Opens an input file or URL with provided dictionary options.

```APIDOC
## Function: input_with_dictionary

### Description
Opens an input file or URL using the provided dictionary of options. This function returns an `Input` object or an `Error` if the operation fails.

### Signature
`pub fn input_with_dictionary<P, Dict>(path_or_url: P, options: Dict) -> Result<Input, Error>`

### Parameters
- **path_or_url** (P: AsRef<OsStr>) - The path or URL to the input source.
- **options** (Dict: AsMutPtr<*mut AVDictionary>) - A dictionary of options to apply to the input.

### Returns
- **Result<Input, Error>** - Returns an `Input` instance on success, or an `Error` if the input could not be opened.
```

--------------------------------

### fn converter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/fn.converter.html?search=std%3A%3Avec

Initializes a conversion context for video processing.

```APIDOC
## Function: converter

### Description
Creates a new conversion context for transforming video frames between two pixel formats with defined dimensions.

### Signature
`pub fn converter((width, height): (u32, u32), input: Pixel, output: Pixel) -> Result<Context, Error>`

### Parameters
- **(width, height)** (u32, u32) - The resolution dimensions for the conversion.
- **input** (Pixel) - The source pixel format.
- **output** (Pixel) - The target pixel format.

### Returns
- **Result<Context, Error>** - Returns a conversion Context on success, or an Error if the initialization fails.
```

--------------------------------

### pub fn license() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/fn.license.html

Retrieves the license information of the FFmpeg library as a static string.

```APIDOC
## Function: license

### Description
Returns the license information of the FFmpeg library currently in use.

### Signature
`pub fn license() -> &'static str`

### Returns
- **&'static str** - A string slice containing the license information.
```

--------------------------------

### pub fn configuration() -> &'static str

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/filter/fn.configuration.html

Retrieves the configuration of the filter as a static string slice.

```APIDOC
## Function: configuration

### Description
Returns the configuration of the filter as a static string.

### Signature
`pub fn configuration() -> &'static str`

### Returns
- **&'static str** - The filter configuration string.
```

--------------------------------

### SideDataIter::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/packet/packet/struct.SideDataIter.html?search=u32+-%3E+bool

Creates a new SideDataIter instance from a raw AVPacket pointer.

```APIDOC
## pub fn new(ptr: *const AVPacket) -> Self

### Description
Creates a new iterator for the side data contained within the provided AVPacket pointer.

### Parameters
- **ptr** (*const AVPacket) - Required - A pointer to the AVPacket structure.
```

--------------------------------

### pub fn audio() -> AudioIter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/input/fn.audio.html

Retrieves an iterator over available audio input devices.

```APIDOC
## Function: audio

### Description
Returns an iterator (`AudioIter`) that allows the user to traverse available audio input devices.

### Signature
`pub fn audio() -> AudioIter`
```

--------------------------------

### Create new PacketIter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/context/input/struct.PacketIter.html?search=

Constructor for creating a new PacketIter instance from an input context.

```rust
pub fn new(context: &mut Input) -> PacketIter<'_>
```

--------------------------------

### Decoder::open

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/decoder/decoder/struct.Decoder.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Opens the decoder with the current context.

```APIDOC
## pub fn open(self) -> Result<Opened, Error>

### Description
Opens the decoder using the current configuration context.

### Returns
- **Result<Opened, Error>** - Returns an Opened decoder instance on success, or an Error if the operation fails.
```

--------------------------------

### Context::get

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/software/resampling/context/struct.Context.html

Creates a new resampler context with the specified source and destination audio formats, channel layouts, and sample rates.

```APIDOC
## fn get(src_format: Sample, src_channel_layout: ChannelLayoutMask, src_rate: u32, dst_format: Sample, dst_channel_layout: ChannelLayoutMask, dst_rate: u32) -> Result<Self, Error>

### Description
Creates a resampler with the given definitions.

### Parameters
- **src_format** (Sample) - Source audio format
- **src_channel_layout** (ChannelLayoutMask) - Source channel layout
- **src_rate** (u32) - Source sample rate
- **dst_format** (Sample) - Destination audio format
- **dst_channel_layout** (ChannelLayoutMask) - Destination channel layout
- **dst_rate** (u32) - Destination sample rate

### Returns
- **Result<Self, Error>** - A new Context instance or an error if initialization fails.
```

--------------------------------

### pub fn audio() -> AudioIter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/output/fn.audio.html

Returns an iterator over available audio output devices.

```APIDOC
## Function: audio

### Description
Returns an iterator (`AudioIter`) over the available audio output devices.

### Signature
`pub fn audio() -> AudioIter`
```

--------------------------------

### pub fn video() -> VideoIter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/input/fn.video.html?search=std%3A%3Avec

The video function returns an iterator over video devices.

```APIDOC
## Function: video

### Description
Returns an iterator (`VideoIter`) for video input devices.

### Signature
`pub fn video() -> VideoIter`

### Returns
- **VideoIter** - An iterator over available video input devices.
```

--------------------------------

### Input Methods

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/format/context/input/struct.Input.html?search=std%3A%3Avec

Methods available on the Input struct for managing media input.

```APIDOC
## pub fn format(&self) -> Input
Returns the format of the input.

## pub fn probe_score(&self) -> i32
Returns the probe score of the input.

## pub fn packets(&mut self) -> PacketIter<'_>
Returns an iterator over the packets of the input.

## pub fn pause(&mut self) -> Result<(), Error>
Pauses the input playback.

## pub fn play(&mut self) -> Result<(), Error>
Resumes the input playback.

## pub fn seek<R: RangeBounds<i64>>(&mut self, ts: i64, range: R) -> Result<(), Error>
Seeks to a specific timestamp within the given range.
```

--------------------------------

### pub fn video() -> VideoIter

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/device/input/fn.video.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves an iterator over available video input devices.

```APIDOC
## Function: video

### Description
Returns an iterator (`VideoIter`) that allows for the enumeration or access of video input devices.

### Signature
`pub fn video() -> VideoIter`
```

--------------------------------

### pub fn new() -> Encoder

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/codec/encoder/fn.new.html

Creates a new instance of an Encoder.

```APIDOC
## Function: new

### Description
Creates and returns a new instance of an `Encoder`.

### Signature
`pub fn new() -> Encoder`

### Returns
- **Encoder** - A new instance of the encoder.
```

--------------------------------

### ChannelCustom::new

Source: https://docs.rs/ffmpeg-the-third/latest/ffmpeg_the_third/util/channel_layout/struct.ChannelCustom.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of ChannelCustom from a given channel identifier.

```APIDOC
## pub fn new(id: Channel) -> Self

### Description
Creates a new ChannelCustom instance using the provided channel identifier.

### Parameters
- **id** (Channel) - Required - The channel identifier to associate with this custom channel.
```
Tokens:
Raw