[][src]Struct gstreamer::SeekFlags

pub struct SeekFlags { /* fields omitted */ }

Flags to be used with Element::seek or Event::new_seek. All flags can be used together.

A non flushing seek might take some time to perform as the currently playing data in the pipeline will not be cleared.

An accurate seek might be slower for formats that don't have any indexes or timestamp markers in the stream. Specifying this flag might require a complete scan of the file in those cases.

When performing a segment seek: after the playback of the segment completes, no EOS will be emitted by the element that performed the seek, but a MessageType::SegmentDone message will be posted on the bus by the element. When this message is posted, it is possible to send a new seek event to continue playback. With this seek method it is possible to perform seamless looping or simple linear editing.

When only changing the playback rate and not the direction, the SeekFlags::InstantRateChange flag can be used for a non-flushing seek to signal that the rate change should be applied immediately. This requires special support in the seek handlers (e.g. demuxers) and any elements synchronizing to the clock, and in general can't work in all cases (for example UDP streaming where the delivery rate is controlled by a remote server). The instant-rate-change mode supports changing the trickmode-related GST_SEEK_ flags, but can't be used in conjunction with other seek flags that affect the new playback position - as the playback position will not be changing.

When doing fast forward (rate > 1.0) or fast reverse (rate < -1.0) trickmode playback, the SeekFlags::Trickmode flag can be used to instruct decoders and demuxers to adjust the playback rate by skipping frames. This can improve performance and decrease CPU usage because not all frames need to be decoded.

Beyond that, the SeekFlags::TrickmodeKeyUnits flag can be used to request that decoders skip all frames except key units, and SeekFlags::TrickmodeNoAudio flags can be used to request that audio decoders do no decoding at all, and simple output silence.

The SeekFlags::SnapBefore flag can be used to snap to the previous relevant location, and the SeekFlags::SnapAfter flag can be used to select the next relevant location. If SeekFlags::KeyUnit is specified, the relevant location is a keyframe. If both flags are specified, the nearest of these locations will be selected. If none are specified, the implementation is free to select whichever it wants.

The before and after here are in running time, so when playing backwards, the next location refers to the one that will played in next, and not the one that is located after in the actual source stream.

Also see part-seeking.txt in the GStreamer design documentation for more details on the meaning of these flags and the behaviour expected of elements that handle them.

Methods

impl SeekFlags[src]

pub const FLUSH: SeekFlags[src]

flush pipeline

pub const ACCURATE: SeekFlags[src]

accurate position is requested, this might be considerably slower for some formats.

pub const KEY_UNIT: SeekFlags[src]

seek to the nearest keyframe. This might be faster but less accurate.

pub const SEGMENT: SeekFlags[src]

perform a segment seek.

pub const TRICKMODE: SeekFlags[src]

when doing fast forward or fast reverse playback, allow elements to skip frames instead of generating all frames. (Since: 1.6)

pub const SKIP: SeekFlags[src]

Deprecated backward compatibility flag, replaced by SeekFlags::Trickmode

pub const SNAP_BEFORE: SeekFlags[src]

go to a location before the requested position, if SeekFlags::KeyUnit this means the keyframe at or before the requested position the one at or before the seek target.

pub const SNAP_AFTER: SeekFlags[src]

go to a location after the requested position, if SeekFlags::KeyUnit this means the keyframe at of after the requested position.

pub const SNAP_NEAREST: SeekFlags[src]

go to a position near the requested position, if SeekFlags::KeyUnit this means the keyframe closest to the requested position, if both keyframes are at an equal distance, behaves like SeekFlags::SnapBefore.

pub const TRICKMODE_KEY_UNITS: SeekFlags[src]

when doing fast forward or fast reverse playback, request that elements only decode keyframes and skip all other content, for formats that have keyframes. (Since: 1.6)

pub const TRICKMODE_NO_AUDIO: SeekFlags[src]

when doing fast forward or fast reverse playback, request that audio decoder elements skip decoding and output only gap events or silence. (Since: 1.6)

pub const TRICKMODE_FORWARD_PREDICTED: SeekFlags[src]

When doing fast forward or fast reverse playback, request that elements only decode keyframes and forward predicted frames and skip all other content (for example B-Frames), for formats that have keyframes and forward predicted frames. (Since: 1.18)

pub const INSTANT_RATE_CHANGE: SeekFlags[src]

Signals that a rate change should be applied immediately. Only valid if start/stop position are GST_CLOCK_TIME_NONE, the playback direction does not change and the seek is not flushing. (Since: 1.18)

pub const fn empty() -> SeekFlags[src]

Returns an empty set of flags

pub const fn all() -> SeekFlags[src]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[src]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<SeekFlags>[src]

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> SeekFlags[src]

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> SeekFlags[src]

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

pub const fn intersects(&self, other: SeekFlags) -> bool[src]

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: SeekFlags) -> bool[src]

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: SeekFlags)[src]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: SeekFlags)[src]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: SeekFlags)[src]

Toggles the specified flags in-place.

pub fn set(&mut self, other: SeekFlags, value: bool)[src]

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for SeekFlags[src]

impl BitAnd<SeekFlags> for SeekFlags[src]

type Output = SeekFlags

The resulting type after applying the & operator.

fn bitand(self, other: SeekFlags) -> SeekFlags[src]

Returns the intersection between the two sets of flags.

impl BitAndAssign<SeekFlags> for SeekFlags[src]

fn bitand_assign(&mut self, other: SeekFlags)[src]

Disables all flags disabled in the set.

impl BitOr<SeekFlags> for SeekFlags[src]

type Output = SeekFlags

The resulting type after applying the | operator.

fn bitor(self, other: SeekFlags) -> SeekFlags[src]

Returns the union of the two sets of flags.

impl BitOrAssign<SeekFlags> for SeekFlags[src]

fn bitor_assign(&mut self, other: SeekFlags)[src]

Adds the set of flags.

impl BitXor<SeekFlags> for SeekFlags[src]

type Output = SeekFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: SeekFlags) -> SeekFlags[src]

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<SeekFlags> for SeekFlags[src]

fn bitxor_assign(&mut self, other: SeekFlags)[src]

Toggles the set of flags.

impl Clone for SeekFlags[src]

impl Copy for SeekFlags[src]

impl Debug for SeekFlags[src]

impl Eq for SeekFlags[src]

impl Extend<SeekFlags> for SeekFlags[src]

impl FromIterator<SeekFlags> for SeekFlags[src]

impl<'a> FromValue<'a> for SeekFlags[src]

impl<'a> FromValueOptional<'a> for SeekFlags[src]

impl Hash for SeekFlags[src]

impl LowerHex for SeekFlags[src]

impl Not for SeekFlags[src]

type Output = SeekFlags

The resulting type after applying the ! operator.

fn not(self) -> SeekFlags[src]

Returns the complement of this set of flags.

impl Octal for SeekFlags[src]

impl Ord for SeekFlags[src]

impl PartialEq<SeekFlags> for SeekFlags[src]

impl PartialOrd<SeekFlags> for SeekFlags[src]

impl SetValue for SeekFlags[src]

impl StaticType for SeekFlags[src]

impl StructuralEq for SeekFlags[src]

impl StructuralPartialEq for SeekFlags[src]

impl Sub<SeekFlags> for SeekFlags[src]

type Output = SeekFlags

The resulting type after applying the - operator.

fn sub(self, other: SeekFlags) -> SeekFlags[src]

Returns the set difference of the two sets of flags.

impl SubAssign<SeekFlags> for SeekFlags[src]

fn sub_assign(&mut self, other: SeekFlags)[src]

Disables all flags enabled in the set.

impl UpperHex for SeekFlags[src]

Auto Trait Implementations

impl RefUnwindSafe for SeekFlags

impl Send for SeekFlags

impl Sync for SeekFlags

impl Unpin for SeekFlags

impl UnwindSafe for SeekFlags

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToSendValue for T where
    T: ToValue + SetValue + Send + ?Sized
[src]

impl<T> ToValue for T where
    T: SetValue + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.