Struct CAClockPropertyID 

#[repr(transparent)]
pub struct CAClockPropertyID(pub u32);

The properties of a CoreAudioClock, accessible via CAClockGetProperty and CAClockSetProperty.

Type: CAClockTimebase. Selects the internal time reference for the clock (currently, host time, an audio device, or audio output unit).

Type: according to the internal timebase. If the timebase is kCAClockTimebase_AudioDevice, the value is an AudioDeviceID. For kCAClockTimebase_AudioOutputUnit, the value is an AudioUnit.

Type: CAClockSyncMode. Selects between internal synchronization and multiple external synchronization modes such as MIDI Time Code and MIDI beat clock.

Type: according to the sync mode. For kCAClockSyncMode_MIDIClockTransport or kCAClockSyncMode_MTCTransport, the value is a MIDIEndpointRef.

Type: CAClockSMPTEFormat. Specifies the SMPTE format (fps, drop or non-drop) expected for received SMPTE messages, and used for transmitted SMPTE messages and SMPTE time representations.

Type: CAClockSeconds. The SMPTE time, represented in seconds since 00:00:00:00, corresponding to a timeline position of 0 seconds.

Type: array of MIDIEndpointRef. When non-empty, the clock will transmit MIDI beat clock to the MIDI endpoints in this list. (As of macOS 10.6, the endpoints may be virtual sources. Previously, they had to be destinations.)

Type: array of MIDIEndpointRef. When non-empty, the clock will transmit MIDI Time Code to the MIDI endpoints in this list. (As of macOS 10.6, the endpoints may be virtual sources. Previously, they had to be destinations.)

Type: CAClockSeconds. When the sync mode is MIDI Time Code, this controls how long the reader will keep running after the last MTC message is received before stopping (default: 1 sec). Should be at least ~4 SMPTE frames in duration.

Type: array of CATempoMapEntry. Specifies a tempo map for the clock, defining the relationship between timeline positions in seconds and musical beats. Defaults to a constant tempo of 120 bpm.

Type: array of CAMeterTrackEntry. Specifies the positions of musical time signature changes in the timeline. Used only for converting between beats and CABarBeatTime’s (a display representation of a beat time).

Type: CFStringRef. Sets a name for the clock. When a client sets the property, the clock retains a reference to the string. When a client gets the property, it receives a borrowed reference (i.e. the client must not release the string).

Type: UInt32. Specifies whether MIDI Song Position Pointer messages are sent to the clock’s MIDI clock destinations (if any). Available starting in macOS 10.6.

See also Apple’s documentation

Tuple Fields

0: u32

Implementations

impl CAClockPropertyID

pub const InternalTimebase: Self

pub const TimebaseSource: Self

pub const SyncMode: Self

pub const SyncSource: Self

pub const SMPTEFormat: Self

pub const SMPTEOffset: Self

pub const MIDIClockDestinations: Self

pub const MTCDestinations: Self

pub const MTCFreewheelTime: Self

pub const TempoMap: Self

pub const MeterTrack: Self

pub const Name: Self

pub const SendMIDISPP: Self

Trait Implementations

impl Clone for CAClockPropertyID

fn clone(&self) -> CAClockPropertyID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CAClockPropertyID

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

Formats the value using the given formatter.

impl Encode for CAClockPropertyID

const ENCODING: Encoding = u32::ENCODING

The Objective-C type-encoding for this type.

impl Hash for CAClockPropertyID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CAClockPropertyID

fn cmp(&self, other: &CAClockPropertyID) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CAClockPropertyID

fn eq(&self, other: &CAClockPropertyID) -> 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 PartialOrd for CAClockPropertyID

fn partial_cmp(&self, other: &CAClockPropertyID) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for CAClockPropertyID

const ENCODING_REF: Encoding

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

impl Copy for CAClockPropertyID

impl Eq for CAClockPropertyID

impl StructuralPartialEq for CAClockPropertyID