Struct gstreamer_video::VideoTimeCode

pub struct VideoTimeCode(_);

field_count must be 0 for progressive video and 1 or 2 for interlaced.

A representation of a SMPTE time code.

hours must be positive and less than 24. Will wrap around otherwise. minutes and seconds must be positive and less than 60. frames must be less than or equal to config.fps_n / config.fps_d These values are NOT automatically normalized.

Feature: v1_10

Methods

impl VideoTimeCode

pub fn new_empty() -> VideoTimeCode

Feature: v1_10

Returns

a new empty, invalid VideoTimeCode

pub fn new(
    fps: Fraction,
    latest_daily_jam: Option<&DateTime>,
    flags: VideoTimeCodeFlags,
    hours: u32,
    minutes: u32,
    seconds: u32,
    frames: u32,
    field_count: u32
) -> Self

field_count is 0 for progressive, 1 or 2 for interlaced. latest_daiy_jam reference is stolen from caller.

Feature: v1_10

fps_n

Numerator of the frame rate

fps_d

Denominator of the frame rate

latest_daily_jam

The latest daily jam of the VideoTimeCode

flags

VideoTimeCodeFlags

hours

the hours field of VideoTimeCode

minutes

the minutes field of VideoTimeCode

seconds

the seconds field of VideoTimeCode

frames

the frames field of VideoTimeCode

field_count

Interlaced video field count

Returns

a new VideoTimeCode with the given values. The values are not checked for being in a valid range. To see if your timecode actually has valid content, use VideoTimeCode::is_valid.

pub fn new_from_date_time(
    fps: Fraction,
    dt: &DateTime,
    flags: VideoTimeCodeFlags,
    field_count: u32
) -> Result<VideoTimeCode, BoolError>

The resulting config->latest_daily_jam is set to midnight, and timecode is set to the given time.

This might return a completely invalid timecode, use VideoTimeCode::new_from_date_time_full to ensure that you would get None instead in that case.

Feature: v1_12

fps_n

Numerator of the frame rate

fps_d

Denominator of the frame rate

dt

glib::DateTime to convert

flags

VideoTimeCodeFlags

field_count

Interlaced video field count

Returns

the VideoTimeCode representation of dt.

pub fn is_valid(&self) -> bool

Feature: v1_10

Returns

whether self is a valid timecode (supported frame rate, hours/minutes/seconds/frames not overflowing)

pub fn set_fps(&mut self, fps: Fraction)

pub fn set_flags(&mut self, flags: VideoTimeCodeFlags)

pub fn set_hours(&mut self, hours: u32)

pub fn set_minutes(&mut self, minutes: u32)

pub fn set_seconds(&mut self, seconds: u32)

pub fn set_frames(&mut self, frames: u32)

pub fn set_field_count(&mut self, field_count: u32)

impl VideoTimeCode

pub fn get_hours(&self) -> u32

pub fn get_minutes(&self) -> u32

pub fn get_seconds(&self) -> u32

pub fn get_frames(&self) -> u32

pub fn get_field_count(&self) -> u32

pub fn get_fps(&self) -> Fraction

pub fn get_flags(&self) -> VideoTimeCodeFlags

pub fn get_latest_daily_jam(&self) -> Option<DateTime>

pub fn set_latest_daily_jam(&mut self, latest_daily_jam: Option<&DateTime>)

Trait Implementations

impl Clone for VideoTimeCode

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VideoTimeCode

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

Formats the value using the given formatter.

impl Display for VideoTimeCode

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

Formats the value using the given formatter.

impl Drop for VideoTimeCode

fn drop(&mut self)

Executes the destructor for this type.

impl From<ValidVideoTimeCode> for VideoTimeCode

fn from(v: ValidVideoTimeCode) -> VideoTimeCode

Performs the conversion.

impl FromStr for VideoTimeCode

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, BoolError>

Parses a string s to return a value of this type.

impl Send for VideoTimeCode

impl StaticType for VideoTimeCode

fn static_type() -> Type

Returns the type identifier of Self.

impl Sync for VideoTimeCode

impl TryFrom<VideoTimeCode> for ValidVideoTimeCode

type Error = VideoTimeCode

The type returned in the event of a conversion error.

fn try_from(v: VideoTimeCode) -> Result<ValidVideoTimeCode, VideoTimeCode>

Performs the conversion.