Struct MediaInfo 

pub struct MediaInfo { /* private fields */ }

Information about a media file.

This struct contains all metadata about a media container, including format information, duration, file size, and all contained streams.

Construction

Use MediaInfo::builder() for fluent construction:

use ff_format::media::MediaInfo;
use std::time::Duration;

let info = MediaInfo::builder()
    .path("/path/to/video.mp4")
    .format("mp4")
    .duration(Duration::from_secs(120))
    .file_size(1_000_000)
    .build();

Implementations

impl MediaInfo

pub fn builder() -> MediaInfoBuilder

Creates a new builder for constructing MediaInfo.

Examples

use ff_format::media::MediaInfo;
use std::time::Duration;

let info = MediaInfo::builder()
    .path("/path/to/video.mp4")
    .format("mp4")
    .duration(Duration::from_secs(120))
    .file_size(1_000_000)
    .build();

pub fn path(&self) -> &Path

Returns the file path.

pub fn format(&self) -> &str

Returns the container format name.

pub fn format_long_name(&self) -> Option<&str>

Returns the long format name, if available.

pub const fn duration(&self) -> Duration

Returns the total duration.

pub const fn file_size(&self) -> u64

Returns the file size in bytes.

pub const fn bitrate(&self) -> Option<u64>

Returns the overall bitrate in bits per second, if known.

pub fn video_streams(&self) -> &[VideoStreamInfo]

Returns all video streams in the file.

pub fn audio_streams(&self) -> &[AudioStreamInfo]

Returns all audio streams in the file.

pub fn subtitle_streams(&self) -> &[SubtitleStreamInfo]

Returns all subtitle streams in the file.

pub fn chapters(&self) -> &[ChapterInfo]

Returns all chapters in the file.

pub fn has_chapters(&self) -> bool

Returns true if the file contains at least one chapter marker.

pub fn chapter_count(&self) -> usize

Returns the number of chapters.

pub fn metadata(&self) -> &HashMap<String, String>

Returns the file metadata.

pub fn metadata_value(&self, key: &str) -> Option<&str>

Returns a specific metadata value by key.

pub fn has_video(&self) -> bool

Returns true if the file contains at least one video stream.

pub fn has_audio(&self) -> bool

Returns true if the file contains at least one audio stream.

pub fn has_subtitles(&self) -> bool

Returns true if the file contains at least one subtitle stream.

pub fn video_stream_count(&self) -> usize

Returns the number of video streams.

pub fn audio_stream_count(&self) -> usize

Returns the number of audio streams.

pub fn subtitle_stream_count(&self) -> usize

Returns the number of subtitle streams.

pub fn stream_count(&self) -> usize

Returns the total number of streams (video + audio + subtitle).

pub fn primary_video(&self) -> Option<&VideoStreamInfo>

Returns the primary video stream.

The primary video stream is the first video stream in the file. Returns None if there are no video streams.

pub fn primary_audio(&self) -> Option<&AudioStreamInfo>

Returns the primary audio stream.

The primary audio stream is the first audio stream in the file. Returns None if there are no audio streams.

pub fn video_stream(&self, index: usize) -> Option<&VideoStreamInfo>

Returns a video stream by index within the video streams list.

pub fn audio_stream(&self, index: usize) -> Option<&AudioStreamInfo>

Returns an audio stream by index within the audio streams list.

pub fn subtitle_stream(&self, index: usize) -> Option<&SubtitleStreamInfo>

Returns a subtitle stream by index within the subtitle streams list.

pub fn resolution(&self) -> Option<(u32, u32)>

Returns the resolution of the primary video stream.

Returns None if there are no video streams.

pub fn frame_rate(&self) -> Option<f64>

Returns the frame rate of the primary video stream.

Returns None if there are no video streams.

pub fn sample_rate(&self) -> Option<u32>

Returns the sample rate of the primary audio stream.

Returns None if there are no audio streams.

pub fn channels(&self) -> Option<u32>

Returns the channel count of the primary audio stream.

Returns None if there are no audio streams.

pub fn is_video_only(&self) -> bool

Returns true if this is a video-only file (no audio streams).

pub fn is_audio_only(&self) -> bool

Returns true if this is an audio-only file (no video streams).

pub fn file_name(&self) -> Option<&str>

Returns the file name (without directory path).

pub fn extension(&self) -> Option<&str>

Returns the file extension.

pub fn title(&self) -> Option<&str>

Returns the title from metadata.

This is a convenience method for accessing the “title” metadata key, which is commonly used by media containers to store the title of the content.

pub fn artist(&self) -> Option<&str>

Returns the artist from metadata.

This is a convenience method for accessing the “artist” metadata key.

pub fn album(&self) -> Option<&str>

Returns the album from metadata.

This is a convenience method for accessing the “album” metadata key.

pub fn creation_time(&self) -> Option<&str>

Returns the creation time from metadata.

This is a convenience method for accessing the creation_time metadata key, which is commonly used by media containers to store when the file was created. The format is typically ISO 8601 (e.g., 2024-01-15T10:30:00.000000Z).

pub fn date(&self) -> Option<&str>

Returns the date from metadata.

This is a convenience method for accessing the “date” metadata key.

pub fn comment(&self) -> Option<&str>

Returns the comment from metadata.

This is a convenience method for accessing the “comment” metadata key.

pub fn encoder(&self) -> Option<&str>

Returns the encoder from metadata.

This is a convenience method for accessing the “encoder” metadata key, which stores information about the software used to create the file.

Trait Implementations

impl Clone for MediaInfo

fn clone(&self) -> MediaInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MediaInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MediaInfo

fn default() -> Self

Returns the “default value” for a type.