libmpv  20200718-git-96cdf53
development library for the MPV media player
Looking for a C++ dev?
I'm looking for work. Hire me!
mpv_event_end_file Struct Reference

#include <client.h>

Public Attributes

int reason
 Corresponds to the values in enum mpv_end_file_reason (the "int" type will be replaced with mpv_end_file_reason on the next ABI bump). More...
 
int error
 If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code (one of MPV_ERROR_...) giving an approximate reason why playback failed. More...
 
int64_t playlist_entry_id
 Playlist entry ID of the file that was being played or attempted to be played. More...
 
int64_t playlist_insert_id
 If loading ended, because the playlist entry to be played was for example a playlist, and the current playlist entry is replaced with a number of other entries. More...
 
int playlist_insert_num_entries
 See playlist_insert_id. More...
 

Detailed Description

Definition at line 1626 of file client.h.

Member Data Documentation

◆ error

int mpv_event_end_file::error

If reason==MPV_END_FILE_REASON_ERROR, this contains a mpv error code (one of MPV_ERROR_...) giving an approximate reason why playback failed.

In other cases, this field is 0 (no error). Since API version 1.9.

Definition at line 1640 of file client.h.

◆ playlist_entry_id

int64_t mpv_event_end_file::playlist_entry_id

Playlist entry ID of the file that was being played or attempted to be played.

This has the same value as the playlist_entry_id field in the corresponding mpv_event_start_file event. Since API version 1.108.

Definition at line 1647 of file client.h.

◆ playlist_insert_id

int64_t mpv_event_end_file::playlist_insert_id

If loading ended, because the playlist entry to be played was for example a playlist, and the current playlist entry is replaced with a number of other entries.

This may happen at least with MPV_END_FILE_REASON_REDIRECT (other event types may use this for similar but different purposes in the future). In this case, playlist_insert_id will be set to the playlist entry ID of the first inserted entry, and playlist_insert_num_entries to the total number of inserted playlist entries. Note this in this specific case, the ID of the last inserted entry is playlist_insert_id+num-1. Beware that depending on circumstances, you may observe the new playlist entries before seeing the event (e.g. reading the "playlist" property or getting a property change notification before receiving the event). Since API version 1.108.

Definition at line 1662 of file client.h.

◆ playlist_insert_num_entries

int mpv_event_end_file::playlist_insert_num_entries

See playlist_insert_id.

Only non-0 if playlist_insert_id is valid. Never negative. Since API version 1.108.

Definition at line 1668 of file client.h.

◆ reason

int mpv_event_end_file::reason

Corresponds to the values in enum mpv_end_file_reason (the "int" type will be replaced with mpv_end_file_reason on the next ABI bump).

Unknown values should be treated as unknown.

Definition at line 1633 of file client.h.


The documentation for this struct was generated from the following file: