mpv_error enum

List of error codes than can be returned by API functions. 0 and positive return values always mean success, negative values are always errors.

Inheritance
Available extensions

Values

MPV_ERROR_SUCCESS → const mpv_error

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. API users can hardcode the fact that ">= 0" means success.

const mpv_error(0)
MPV_ERROR_EVENT_QUEUE_FULL → const mpv_error

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".)

const mpv_error(-1)
MPV_ERROR_NOMEM → const mpv_error

Memory allocation failed.

const mpv_error(-2)
MPV_ERROR_UNINITIALIZED → const mpv_error

The mpv core wasn't configured and initialized yet. See the notes in mpv_create().

const mpv_error(-3)
MPV_ERROR_INVALID_PARAMETER → const mpv_error

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.

const mpv_error(-4)
MPV_ERROR_OPTION_NOT_FOUND → const mpv_error

Trying to set an option that doesn't exist.

const mpv_error(-5)
MPV_ERROR_OPTION_FORMAT → const mpv_error

Trying to set an option using an unsupported MPV_FORMAT.

const mpv_error(-6)
MPV_ERROR_OPTION_ERROR → const mpv_error

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

const mpv_error(-7)
MPV_ERROR_PROPERTY_NOT_FOUND → const mpv_error

The accessed property doesn't exist.

const mpv_error(-8)
MPV_ERROR_PROPERTY_FORMAT → const mpv_error

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

const mpv_error(-9)
MPV_ERROR_PROPERTY_UNAVAILABLE → const mpv_error

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.

const mpv_error(-10)
MPV_ERROR_PROPERTY_ERROR → const mpv_error

Error setting or getting a property.

const mpv_error(-11)
MPV_ERROR_COMMAND → const mpv_error

General error when running a command with mpv_command and similar.

const mpv_error(-12)
MPV_ERROR_LOADING_FAILED → const mpv_error

Generic error on loading (usually used with mpv_event_end_file.error).

const mpv_error(-13)
MPV_ERROR_AO_INIT_FAILED → const mpv_error

Initializing the audio output failed.

const mpv_error(-14)
MPV_ERROR_VO_INIT_FAILED → const mpv_error

Initializing the video output failed.

const mpv_error(-15)
MPV_ERROR_NOTHING_TO_PLAY → const mpv_error

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.

const mpv_error(-16)
MPV_ERROR_UNKNOWN_FORMAT → const mpv_error

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

const mpv_error(-17)
MPV_ERROR_UNSUPPORTED → const mpv_error

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

const mpv_error(-18)
MPV_ERROR_NOT_IMPLEMENTED → const mpv_error

The API function which was called is a stub only.

const mpv_error(-19)
MPV_ERROR_GENERIC → const mpv_error

Unspecified error.

const mpv_error(-20)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → int
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromValue(int value) → mpv_error

Constants

values → const List<mpv_error>
A constant List of the values in this enum, in order of their declaration.