Struct rerun::sdk::prelude::VideoFrameReference
source · pub struct VideoFrameReference {
pub timestamp: VideoTimestamp,
pub video_reference: Option<EntityPath>,
}
Expand description
Archetype: References a single video frame.
Used to display individual video frames from a archetypes::AssetVideo
.
To show an entire video, a video frame reference for each frame of the video should be logged.
See https://rerun.io/docs/reference/video for details of what is and isn’t supported.
§Examples
§Video with automatically determined frames
use rerun::external::anyhow;
fn main() -> anyhow::Result<()> {
let args = _args;
let Some(path) = args.get(1) else {
// TODO(#7354): Only mp4 is supported for now.
anyhow::bail!("Usage: {} <path_to_video.[mp4]>", args[0]);
};
let rec =
rerun::RecordingStreamBuilder::new("rerun_example_asset_video_auto_frames").spawn()?;
// Log video asset which is referred to by frame references.
let video_asset = rerun::AssetVideo::from_file_path(path)?;
rec.log_static("video", &video_asset)?;
// Send automatically determined video frame timestamps.
let frame_timestamps_ns = video_asset.read_frame_timestamps_ns()?;
let video_timestamps_ns = frame_timestamps_ns
.iter()
.copied()
.map(rerun::components::VideoTimestamp::from_nanoseconds)
.collect::<Vec<_>>();
let time_column = rerun::TimeColumn::new_nanos(
"video_time",
// Note timeline values don't have to be the same as the video timestamps.
frame_timestamps_ns,
);
let frame_reference_indicators =
<rerun::VideoFrameReference as rerun::Archetype>::Indicator::new_array(
time_column.num_rows(),
);
rec.send_columns(
"video",
[time_column],
[&frame_reference_indicators as _, &video_timestamps_ns as _],
)?;
Ok(())
}
§Demonstrates manual use of video frame references
use rerun::external::anyhow;
fn main() -> anyhow::Result<()> {
let args = _args;
let Some(path) = args.get(1) else {
// TODO(#7354): Only mp4 is supported for now.
anyhow::bail!("Usage: {} <path_to_video.[mp4]>", args[0]);
};
let rec =
rerun::RecordingStreamBuilder::new("rerun_example_asset_video_manual_frames").spawn()?;
// Log video asset which is referred to by frame references.
rec.log_static("video_asset", &rerun::AssetVideo::from_file_path(path)?)?;
// Create two entities, showing the same video frozen at different times.
rec.log(
"frame_1s",
&rerun::VideoFrameReference::new(rerun::components::VideoTimestamp::from_seconds(1.0))
.with_video_reference("video_asset"),
)?;
rec.log(
"frame_2s",
&rerun::VideoFrameReference::new(rerun::components::VideoTimestamp::from_seconds(2.0))
.with_video_reference("video_asset"),
)?;
// TODO(#5520): log blueprint once supported
Ok(())
}
Fields§
§timestamp: VideoTimestamp
References the closest video frame to this timestamp.
Note that this uses the closest video frame instead of the latest at this timestamp in order to be more forgiving of rounding errors for inprecise timestamp types.
Timestamps are relative to the start of the video, i.e. a timestamp of 0 always corresponds to the first frame. This is oftentimes equivalent to presentation timestamps (known as PTS), but in the presence of B-frames (bidirectionally predicted frames) there may be an offset on the first presentation timestamp in the video.
video_reference: Option<EntityPath>
Optional reference to an entity with a archetypes::AssetVideo
.
If none is specified, the video is assumed to be at the same entity. Note that blueprint overrides on the referenced video will be ignored regardless, as this is always interpreted as a reference to the data store.
For a series of video frame references, it is recommended to specify this path only once at the beginning of the series and then rely on latest-at query semantics to keep the video reference active.
Implementations§
source§impl VideoFrameReference
impl VideoFrameReference
sourcepub const NUM_COMPONENTS: usize = 3usize
pub const NUM_COMPONENTS: usize = 3usize
The total number of components in the archetype: 1 required, 1 recommended, 1 optional
source§impl VideoFrameReference
impl VideoFrameReference
sourcepub fn new(timestamp: impl Into<VideoTimestamp>) -> VideoFrameReference
pub fn new(timestamp: impl Into<VideoTimestamp>) -> VideoFrameReference
Create a new VideoFrameReference
.
sourcepub fn with_video_reference(
self,
video_reference: impl Into<EntityPath>
) -> VideoFrameReference
pub fn with_video_reference( self, video_reference: impl Into<EntityPath> ) -> VideoFrameReference
Optional reference to an entity with a archetypes::AssetVideo
.
If none is specified, the video is assumed to be at the same entity. Note that blueprint overrides on the referenced video will be ignored regardless, as this is always interpreted as a reference to the data store.
For a series of video frame references, it is recommended to specify this path only once at the beginning of the series and then rely on latest-at query semantics to keep the video reference active.
Trait Implementations§
source§impl Archetype for VideoFrameReference
impl Archetype for VideoFrameReference
§type Indicator = GenericIndicatorComponent<VideoFrameReference>
type Indicator = GenericIndicatorComponent<VideoFrameReference>
source§fn name() -> ArchetypeName
fn name() -> ArchetypeName
rerun.archetypes.Points2D
.source§fn display_name() -> &'static str
fn display_name() -> &'static str
source§fn indicator() -> MaybeOwnedComponentBatch<'static>
fn indicator() -> MaybeOwnedComponentBatch<'static>
source§fn required_components() -> Cow<'static, [ComponentName]>
fn required_components() -> Cow<'static, [ComponentName]>
source§fn recommended_components() -> Cow<'static, [ComponentName]>
fn recommended_components() -> Cow<'static, [ComponentName]>
source§fn optional_components() -> Cow<'static, [ComponentName]>
fn optional_components() -> Cow<'static, [ComponentName]>
source§fn all_components() -> Cow<'static, [ComponentName]>
fn all_components() -> Cow<'static, [ComponentName]>
source§fn from_arrow_components(
arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)>
) -> Result<VideoFrameReference, DeserializationError>
fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<VideoFrameReference, DeserializationError>
ComponentNames
, deserializes them
into this archetype. Read moresource§fn from_arrow(
data: impl IntoIterator<Item = (Field, Box<dyn Array>)>
) -> Result<Self, DeserializationError>where
Self: Sized,
fn from_arrow(
data: impl IntoIterator<Item = (Field, Box<dyn Array>)>
) -> Result<Self, DeserializationError>where
Self: Sized,
source§impl AsComponents for VideoFrameReference
impl AsComponents for VideoFrameReference
source§fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>
fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>
ComponentBatch
s. Read moresource§impl Clone for VideoFrameReference
impl Clone for VideoFrameReference
source§fn clone(&self) -> VideoFrameReference
fn clone(&self) -> VideoFrameReference
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for VideoFrameReference
impl Debug for VideoFrameReference
source§impl SizeBytes for VideoFrameReference
impl SizeBytes for VideoFrameReference
source§fn heap_size_bytes(&self) -> u64
fn heap_size_bytes(&self) -> u64
self
on the heap, in bytes.source§fn total_size_bytes(&self) -> u64
fn total_size_bytes(&self) -> u64
self
in bytes, accounting for both stack and heap space.source§fn stack_size_bytes(&self) -> u64
fn stack_size_bytes(&self) -> u64
self
on the stack, in bytes. Read moreimpl ArchetypeReflectionMarker for VideoFrameReference
Auto Trait Implementations§
impl Freeze for VideoFrameReference
impl RefUnwindSafe for VideoFrameReference
impl Send for VideoFrameReference
impl Sync for VideoFrameReference
impl Unpin for VideoFrameReference
impl UnwindSafe for VideoFrameReference
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request