Struct CMTimeRange 

#[repr(C)]
pub struct CMTimeRange {
    pub start: CMTime,
    pub duration: CMTime,
}

Available on crate features CMTime and CMTimeRange only.

A time range represented as two CMTime structures.

See also Apple’s documentation

Fields

start: CMTime

The start time of the time range.

duration: CMTime

The duration of the time range.

Implementations

impl CMTimeRange

pub unsafe fn new(start: CMTime, duration: CMTime) -> CMTimeRange

Make a valid CMTimeRange with start and duration.

Returns: The resulting CMTimeRange.

The duration parameter must have an epoch of 0; otherwise an invalid time range will be returned.

pub unsafe fn union(self, other_range: CMTimeRange) -> CMTimeRange

Returns the union of two CMTimeRanges.

This function returns a CMTimeRange structure that represents the union of the time ranges specified by the range and otherRange parameters. This is the smallest range that includes all times that are in either range.

Returns: The union of the two CMTimeRanges.

pub unsafe fn intersection(self, other_range: CMTimeRange) -> CMTimeRange

Returns the intersection of two CMTimeRanges.

This function returns a CMTimeRange structure that represents the intersection of the time ranges specified by the range and otherRange parameters. This is the largest range that both ranges include.

Returns: The intersection of the two CMTimeRanges.

pub unsafe fn equal(self, range2: CMTimeRange) -> bool

Returns a Boolean value that indicates whether two CMTimeRanges are identical.

This function returns a Boolean value that indicates whether the time ranges specified by the range1 and range2 parameters are identical.

Returns: Returns true if the two time ranges are identical, false if they differ.

pub unsafe fn contains_time(self, time: CMTime) -> bool

Indicates whether a time is contained within a time range.

This function returns a Boolean value that indicates whether the time specified by the time parameter is contained within the range specified by the range parameter.

Returns: Returns true if the specified time is contained within the specified time range, false if it is not.

pub unsafe fn contains_time_range(self, other_range: CMTimeRange) -> bool

Indicates whether a time range is contained within a time range.

This function returns a Boolean value that indicates whether the time range specified by the range parameter contains the range specified by the otherRange parameter.

Returns: Returns true if the second time range is contained within the first time range, false if it is not.

pub unsafe fn end(self) -> CMTime

Returns a CMTime structure representing the end of a time range.

Returns: A CMTime structure representing the end of the specified time range.

This function returns a CMTime structure that indicates the end of the time range specified by the range parameter. CMTimeRangeContainsTime(range, CMTimeRangeGetEnd(range)) is always false.

impl CMTimeRange

pub unsafe fn from_time_to_time(start: CMTime, end: CMTime) -> CMTimeRange

Make a valid CMTimeRange with the given starting and ending times.

Returns: The resulting CMTimeRange.

pub unsafe fn as_dictionary( self, allocator: Option<&CFAllocator>, ) -> Option<CFRetained<CFDictionary>>

Returns a CFDictionary version of a CMTimeRange.

This is useful when putting CMTimeRanges in CF container types.

Returns: A CFDictionary version of the CMTimeRange.

pub unsafe fn from_dictionary( dictionary_representation: &CFDictionary, ) -> CMTimeRange

Reconstitutes a CMTimeRange struct from a CFDictionary previously created by CMTimeRangeCopyAsDictionary.

This is useful when getting CMTimeRanges from CF container types. If the CFDictionary does not have the requisite keyed values, an invalid time range is returned.

Returns: The created CMTimeRange.

Safety

dictionary_representation generics must be of the correct type.

impl CMTimeRange

pub unsafe fn description( allocator: Option<&CFAllocator>, range: CMTimeRange, ) -> Option<CFRetained<CFString>>

Creates a CFString with a description of a CMTimeRange (just like CFCopyDescription).

This is used from within CFShow on an object that contains CMTimeRange fields. It is also useful from other client debugging code. The caller owns the returned CFString and is responsible for releasing it.

Returns: The created CFString description.

pub unsafe fn show(self)

Prints a description of the CMTimeRange (just like CFShow).

This is most useful from within gdb.

Trait Implementations

impl Clone for CMTimeRange

fn clone(&self) -> CMTimeRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CMTimeRange

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

Formats the value using the given formatter.

impl Encode for CMTimeRange

Available on crate feature objc2 only.

const ENCODING: Encoding

The Objective-C type-encoding for this type.

impl PartialEq for CMTimeRange

fn eq(&self, other: &CMTimeRange) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for CMTimeRange

Available on crate feature objc2 only.

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for CMTimeRange

impl StructuralPartialEq for CMTimeRange