Struct VideoEncoder 

pub struct VideoEncoder { /* private fields */ }

Encodes video frames (and optional audio) and writes them to a file or stream.

Frames are provided as Direct3D surfaces or raw BGRA buffers. Audio can be pushed as interleaved PCM bytes.

• Use VideoEncoder::new for file output or VideoEncoder::new_from_stream for stream output.
• Push frames with VideoEncoder::send_frame or VideoEncoder::send_frame_buffer.
• Optionally push audio with VideoEncoder::send_audio_buffer or use VideoEncoder::send_frame_with_audio.
• Call VideoEncoder::finish to finalize the container.

Example

use windows_capture::encoder::{
    AudioSettingsBuilder, ContainerSettingsBuilder, VideoEncoder, VideoSettingsBuilder,
};

// Create an encoder that outputs H.265 in an MP4 container
let mut encoder = VideoEncoder::new(
    VideoSettingsBuilder::new(1920, 1080),
    AudioSettingsBuilder::new().disabled(true),
    ContainerSettingsBuilder::new(),
    "capture.mp4",
)
.unwrap();

// In your capture loop, push frames:
// encoder.send_frame(&frame).unwrap();

// When done:
// encoder.finish().unwrap();

Implementations

impl VideoEncoder

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

Constructs a new VideoEncoder that writes to a file path.

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

Constructs a new VideoEncoder that writes to the given stream.

Unlike VideoEncoder::new, which writes directly to a file, this constructor writes encoded output into any [IRandomAccessStream]. Use [InMemoryRandomAccessStream] to keep the encoded video in memory (e.g., for network streaming or further processing).

Example

use windows::Storage::Streams::InMemoryRandomAccessStream;
use windows::core::Interface;
use windows_capture::encoder::{
    AudioSettingsBuilder, ContainerSettingsBuilder, VideoEncoder, VideoSettingsBuilder,
};

let stream = InMemoryRandomAccessStream::new().unwrap();

let encoder = VideoEncoder::new_from_stream(
    VideoSettingsBuilder::new(1920, 1080),
    AudioSettingsBuilder::new().disabled(true),
    ContainerSettingsBuilder::new(),
    stream.cast().unwrap(),
)
.unwrap();

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

Sends a video frame (DirectX). Returns immediately.

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

Sends a video frame and an audio buffer (owned). Returns immediately. Audio timestamp is derived from total samples sent so far (monotonic).

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

Sends a raw frame buffer (owned inside). Returns immediately. Windows expects BGRA and bottom-to-top layout for this path.

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

Sends an audio buffer (owned inside). Returns immediately. NOTE: The provided timestamp is ignored; we use a monotonic audio clock.

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

Finishes the encoding and performs any necessary cleanup.

Trait Implementations

impl Drop for VideoEncoder

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for VideoEncoder