Struct EndFile

pub struct EndFile {
    pub reason: EndFileReason,
    pub playlist_entry_id: i64,
    pub playlist_insert_id: i64,
    pub playlist_insert_num_entries: i32,
}

Details provided to Event::EndFile.

Fields

reason: EndFileReason

The reason why the file ended.

playlist_entry_id: i64

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

This has the same value as the StartFile.playlist_entry_id field in the corresponding Event::StartFile event.

playlist_insert_id: i64

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 EndFileReason::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 + playlist_insert_num_entries - 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).

playlist_insert_num_entries: i32

See playlist_insert_id. Only non-0 if playlist_insert_id is valid. Never negative.

Trait Implementations

impl Debug for EndFile

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

Formats the value using the given formatter.