Struct MediaInfo

Source

pub struct MediaInfo { /* private fields */ }

Expand description

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§

Source §

impl MediaInfo

Source

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();

Source

pub fn path(&self) -> &Path

Returns the file path.

Source

pub fn format(&self) -> &str

Returns the container format name.

Source

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

Returns the long format name, if available.

Source

pub const fn duration(&self) -> Duration

Returns the total duration.

Source

pub const fn file_size(&self) -> u64

Returns the file size in bytes.

Source

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

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

Source

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

Returns all video streams in the file.

Source

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

Returns all audio streams in the file.

Source

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

Returns all subtitle streams in the file.

Source

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

Returns all chapters in the file.

Source

pub fn has_chapters(&self) -> bool

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

Source

pub fn chapter_count(&self) -> usize

Returns the number of chapters.

Source

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

Returns the file metadata.

Source

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

Returns a specific metadata value by key.

Source

pub fn has_video(&self) -> bool

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

Source

pub fn has_audio(&self) -> bool

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

Source

pub fn has_subtitles(&self) -> bool

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

Source

pub fn video_stream_count(&self) -> usize

Returns the number of video streams.

Source

pub fn audio_stream_count(&self) -> usize

Returns the number of audio streams.

Source

pub fn subtitle_stream_count(&self) -> usize

Returns the number of subtitle streams.

Source

pub fn stream_count(&self) -> usize

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

Source

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.

Source

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.

Source

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

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

Source

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

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

Source

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

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

Source

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

Returns the resolution of the primary video stream.

Returns None if there are no video streams.

Source

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

Returns the frame rate of the primary video stream.

Returns None if there are no video streams.

Source

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

Returns the sample rate of the primary audio stream.

Returns None if there are no audio streams.

Source

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

Returns the channel count of the primary audio stream.

Returns None if there are no audio streams.

The type is u32 to match FFmpeg and professional audio APIs. For rodio or cpal (which require u16), cast with .map(|c| c as u16) — channel counts never exceed u16::MAX in practice.

Source

pub fn is_video_only(&self) -> bool

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

Source

pub fn is_audio_only(&self) -> bool

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

Source

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

Returns the file name (without directory path).

Source

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

Returns the file extension.

Source

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.

Source

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

Returns the artist from metadata.

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

Source

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

Returns the album from metadata.

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

Source

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).

Source