Struct Comments 

pub struct Comments { /* private fields */ }

Comments to be attached to an Ogg Opus file.

Can contain metadata in VorbisComment format and images.

Example

use opusenc::{Comments, PicardTag, RecommendedTag};

let comments = Comments::create()
    .add(RecommendedTag::Title, "The Hardest Button to Button")?
    .add(RecommendedTag::Artist, "The White Stripes")?
    .add(RecommendedTag::Album, "Elephant")?
    .add(RecommendedTag::TrackNumber, "9")?
    .add(PicardTag::AlbumArtist, "The White Stripes")?
    .add(RecommendedTag::Isrc, "USVT10300009")?;

Implementations

impl Comments

pub fn create() -> Self

Create a new comments object.

impl Comments

pub fn add( &mut self, tag: impl AsRef<CStr>, val: impl Into<Vec<u8>>, ) -> Result<&mut Self>

Add a comment.

For common tags, see RecommendedTag and PicardTag.

Tag names must not contain the = charater.

pub fn add_string( &mut self, tag_and_val: impl Into<Vec<u8>>, ) -> Result<&mut Self>

Add a comment as a single tag=value string.

The string must contain the = character.

pub fn add_picture( &mut self, filename: impl AsRef<Path>, picture_type: PictureType, description: Option<impl Into<Vec<u8>>>, ) -> Result<&mut Self>

Add a picture from a file.

pub fn add_picture_from_memory( &mut self, picture: impl AsRef<[u8]>, picture_type: PictureType, description: Option<impl Into<Vec<u8>>>, ) -> Result<&mut Self>

Add a picture already in memory.

impl Comments

pub fn ptr(&self) -> *mut OggOpusComments

Trait Implementations

impl Clone for Comments

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Comments

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Comments

fn drop(&mut self)

Executes the destructor for this type.