Struct jack::TransportPosition [−][src]
#[repr(transparent)]pub struct TransportPosition(_);
Expand description
A structure representing the transport position.
Implementations
Query to see if the frame offset of BarBeatsTick data is valid.
Get the frame number on the transport timeline.
Remarks
- This is not the same as what jack_frame_time returns.
Get the current frame rate, in frames per second.
Remarks
- This is only set by the server so it will be
None
if this struct hasn’t come from the sever.
Get a microsecond timestamp.
Remarks
- This is only set by the server so it will be
None
if this struct hasn’t come from the sever. - Guaranteed to be monotonic, but not neccessarily linear.
- The absolute value is implementation-dependent (i.e. it could be wall-clock, time since jack started, uptime, etc).
Get the BarBeatsTick data if it is valid.
pub fn set_bbt(
&mut self,
bbt: Option<TransportBBT>
) -> Result<(), TransportBBTValidationError>
pub fn set_bbt(
&mut self,
bbt: Option<TransportBBT>
) -> Result<(), TransportBBTValidationError>
Get the frame offset for the BBT fields.
Remarks
- Should be assumed to be 0 if
None
. - If this value is Some(0), the bbt time refers to the first frame of this cycle.
- Otherwise, the bbt time refers to a frame that many frames before the start of the cycle.
Set the frame offset for the BBT fields.
Arguments
frame
- The value to set to the offset.None
will invalidate the offset data.
Remarks
- If this value is 0, the bbt time refers to the first frame of this cycle.
- Otherwise, the bbt time refers to a frame that many frames before the start of the cycle.