VideoEncoder

windows_capture::encoder

Struct VideoEncoder 

Source 
pub struct VideoEncoder { /* private fields */ }
Expand description

The VideoEncoder struct is used to encode video frames and save them to a specified file path.

Implementations§

Source§

impl VideoEncoder

Source

pub fn new<P: AsRef<Path>>( video_settings: VideoSettingsBuilder, audio_settings: AudioSettingsBuilder, container_settings: ContainerSettingsBuilder, path: P, ) -> Result<Self, VideoEncoderError>

Creates a new VideoEncoder instance with the specified parameters.

§Arguments
  • encoder_type - The type of video encoder to use.
  • encoder_quality - The quality of the video encoder.
  • width - The width of the video frames.
  • height - The height of the video frames.
  • path - The file path where the encoded video will be saved.
§Returns

Returns a Result containing the VideoEncoder instance if successful, or a VideoEncoderError if an error occurs.

Source

pub fn new_from_stream( video_settings: VideoSettingsBuilder, audio_settings: AudioSettingsBuilder, container_settings: ContainerSettingsBuilder, stream: IRandomAccessStream, ) -> Result<Self, VideoEncoderError>

Creates a new VideoEncoder instance with the specified parameters.

§Arguments
  • encoder_type - The type of video encoder to use.
  • encoder_quality - The quality of the video encoder.
  • width - The width of the video frames.
  • height - The height of the video frames.
  • stream - The stream where the encoded video will be saved.
§Returns

Returns a Result containing the VideoEncoder instance if successful, or a VideoEncoderError if an error occurs.

Source

pub fn send_frame( &mut self, frame: &mut Frame<'_>, ) -> Result<(), VideoEncoderError>

Sends a video frame to the video encoder for encoding.

§Arguments
  • frame - A mutable reference to the Frame to be encoded.
§Returns

Returns Ok(()) if the frame is successfully sent for encoding, or a VideoEncoderError if an error occurs.

Source

pub fn send_frame_with_audio( &mut self, frame: &mut Frame<'_>, audio_buffer: &[u8], ) -> Result<(), VideoEncoderError>

Sends a video frame with audio to the video encoder for encoding.

§Arguments
  • frame - A mutable reference to the Frame to be encoded.
  • audio_buffer - A reference to the audio byte slice to be encoded.
§Returns

Returns Ok(()) if the frame is successfully sent for encoding, or a VideoEncoderError if an error occurs.

Source

pub fn send_frame_buffer( &mut self, buffer: &[u8], timestamp: i64, ) -> Result<(), VideoEncoderError>

Sends a video frame to the video encoder for encoding.

§Arguments
  • buffer - A reference to the frame byte slice to be encoded. The Windows API expects this to be BGRA and bottom-to-top.
  • timestamp - The timestamp of the frame, in 100-nanosecond units.
§Returns

Returns Ok(()) if the frame is successfully sent for encoding, or a VideoEncoderError if an error occurs.

Source

pub fn send_audio_buffer( &mut self, buffer: &[u8], timestamp: i64, ) -> Result<(), VideoEncoderError>

Sends a video audio to the video encoder for encoding.

§Arguments
  • buffer - A reference to the audio byte slice to be encoded.
  • timestamp - The timestamp of the audio buffer, in 100-nanosecond units.
§Returns

Returns Ok(()) if the frame is successfully sent for encoding, or a VideoEncoderError if an error occurs.

Source

pub fn finish(self) -> Result<(), VideoEncoderError>

Finishes encoding the video and performs any necessary cleanup.

§Returns

Returns Ok(()) if the encoding is successfully finished, or a VideoEncoderError if an error occurs.

Trait Implementations§

Source§

impl Drop for VideoEncoder

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for VideoEncoder

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.