Skip to main content

SegmentClock

Struct SegmentClock 

Source
pub struct SegmentClock { /* private fields */ }
Available on crate features hls or record only.
Expand description

Tracks segment boundaries from a frame stream’s keyframes and timestamps.

use arcly_stream::segment::SegmentClock;
use arcly_stream::{CodecId, MediaFrame};
use bytes::Bytes;

let key = |pts| MediaFrame::new_video(pts, pts, Bytes::new(), CodecId::H264, true);
let mut clock = SegmentClock::new(2); // 2-second target

// First keyframe opens segment 0.
let d = clock.observe(&key(0));
assert!(d.open_new && !d.skip && d.cut_previous.is_none());

// A keyframe before the target does not cut.
assert_eq!(clock.observe(&key(1000)).cut_previous, None);

// A keyframe at/after the target cuts the previous segment.
let d = clock.observe(&key(2000));
assert_eq!(d.cut_previous, Some(2.0));
assert!(d.open_new);

Implementations§

Source§

impl SegmentClock

Source

pub fn new(target_secs: u64) -> Self

A clock targeting target_secs-long segments (minimum 1 second).

Source

pub fn is_open(&self) -> bool

Whether a segment is currently open.

Source

pub fn observe(&mut self, frame: &MediaFrame) -> SegmentDecision

Feed one frame and learn what to do with it (call before writing it).

Source

pub fn flush(&mut self) -> Option<f64>

Close any open segment at end-of-stream, returning its duration in seconds (or None if no segment is open).

Trait Implementations§

Source§

impl Clone for SegmentClock

Source§

fn clone(&self) -> SegmentClock

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SegmentClock

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more