Struct TranscodeProfile 

pub struct TranscodeProfile {
    pub name: String,
    pub description: Option<String>,
    pub version: u32,
    pub video: VideoProfileParams,
    pub audio: AudioProfileParams,
    pub container: ContainerParams,
    pub multi_pass: MultiPassMode,
    pub tags: Vec<(String, String)>,
}

A complete, shareable encoding configuration.

Example (round-trip)

use oximedia_transcode::transcode_profile::TranscodeProfile;

let profile = TranscodeProfile::youtube_1080p();
let json = profile.to_json().expect("serialise");
let loaded = TranscodeProfile::from_json(&json).expect("deserialise");
assert_eq!(loaded.name, profile.name);

Fields

name: String

Human-readable name for this profile (e.g. "YouTube 1080p").

description: Option<String>

Optional description explaining intended use.

version: u32

Profile schema version (for future migrations).

video: VideoProfileParams

Video encoding parameters.

audio: AudioProfileParams

Audio encoding parameters.

container: ContainerParams

Container / muxer parameters.

multi_pass: MultiPassMode

Multi-pass encoding mode.

tags: Vec<(String, String)>

Arbitrary key/value tags for tooling metadata.

Implementations

impl TranscodeProfile

pub fn new(name: impl Into<String>) -> Self

Creates a blank profile with default parameters.

pub fn description(self, desc: impl Into<String>) -> Self

Sets the description.

pub fn video(self, params: VideoProfileParams) -> Self

Sets the video parameters.

pub fn audio(self, params: AudioProfileParams) -> Self

Sets the audio parameters.

pub fn container(self, params: ContainerParams) -> Self

Sets the container parameters.

pub fn multi_pass(self, mode: MultiPassMode) -> Self

Sets the multi-pass mode.

pub fn tag(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds a tag to the profile.

pub fn youtube_1080p() -> Self

YouTube 1080p upload profile (H.264 + AAC).

pub fn podcast_opus() -> Self

Podcast / audio-only Opus profile (EBU R128 normalised).

pub fn av1_1080p_archive() -> Self

AV1 1080p archive profile (CRF 28, tile-based parallel).

pub fn to_json(&self) -> Result<String>

Serialises the profile to a JSON string.

Errors

Returns an error if serialisation fails (should not happen for valid profiles).

pub fn to_json_compact(&self) -> Result<String>

Serialises the profile to a compact (non-pretty) JSON string.

Errors

Returns an error if serialisation fails.

pub fn from_json(json: &str) -> Result<Self>

Deserialises a profile from a JSON string.

Errors

Returns an error if the JSON is malformed or the schema does not match.

pub fn save_to_file(&self, path: &Path) -> Result<()>

Saves the profile to a file in JSON format.

Errors

Returns an error if the file cannot be written.

pub fn load_from_file(path: &Path) -> Result<Self>

Loads a profile from a JSON file.

Errors

Returns an error if the file cannot be read or parsed.

Trait Implementations

impl Clone for TranscodeProfile

fn clone(&self) -> TranscodeProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TranscodeProfile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TranscodeProfile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TranscodeProfile

fn eq(&self, other: &TranscodeProfile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TranscodeProfile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TranscodeProfile