Enum Error

pub enum Error {
    Success(i32),
    EventQueueFull,
    NoMemory,
    Uninitialized,
    InvalidParameter,
    OptionNotFound,
    OptionFormat,
    OptionError,
    PropertyNotFound,
    PropertyFormat,
    PropertyUnavailable,
    PropertyError,
    Command,
    LoadingFailed,
    AoInitFailed,
    VoInitFailed,
    NothingToPlay,
    UnknownFormat,
    Unsupported,
    NotImplemented,
    Generic,
    Rust(RustError),
}

List of error codes than can be returned by API functions.

Variants

Success(i32)

No error happened (used to signal successful operation).

Keep in mind that many API functions returning error codes can also return positive values, which also indicate success.

EventQueueFull

The event ringbuffer is full. This means the client is choked, and can’t receive any events. This can happen when too many asynchronous requests have been made, but not answered. Probably never happens in practice, unless the mpv core is frozen for some reason, and the client keeps making asynchronous requests. (Bugs in the client API implementation could also trigger this, e.g. if events become “lost”.)

NoMemory

Memory allocation failed.

Uninitialized

The mpv core wasn’t configured and initialized yet.

InvalidParameter

Generic catch-all error if a parameter is set to an invalid or unsupported value. This is used if there is no better error code.

OptionNotFound

Trying to set an option that doesn’t exist.

OptionFormat

Trying to set an option using an unsupported Format.

OptionError

Setting the option failed. Typically this happens if the provided option value could not be parsed.

PropertyNotFound

The accessed property doesn’t exist.

PropertyFormat

Trying to set or get a property using an unsupported Format.

PropertyUnavailable

The property exists, but is not available. This usually happens when the associated subsystem is not active, e.g. querying audio parameters while audio is disabled.

PropertyError

Error setting or getting a property.

Command

General error when running a command with Handle::command() and similar.

LoadingFailed

Generic error on loading (usually used with EndFileReason::Error(e)).

AoInitFailed

Initializing the audio output failed.

VoInitFailed

Initializing the video output failed.

NothingToPlay

There was no audio or video data to play. This also happens if the file was recognized, but did not contain any audio or video streams, or no streams were selected.

UnknownFormat

When trying to load the file, the file format could not be determined, or the file was too broken to open it.

Unsupported

Generic error for signaling that certain system requirements are not fulfilled.

NotImplemented

The API function which was called is a stub only.

Generic

Unspecified error.

Rust(RustError)

Rust implementation specific error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl From<&Error> for c_int

fn from(value: &Error) -> Self

Converts to this type from the input type.

impl From<NulError> for Error

fn from(value: NulError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(value: Utf8Error) -> Self

Converts to this type from the input type.

impl From<i32> for Error

fn from(value: c_int) -> Self

Converts to this type from the input type.