Enum midi_msg::FileReferenceMsg

pub enum FileReferenceMsg {
    Open {
        ctx: u16,
        file_type: FileReferenceType,
        url: BString,
    },
    SelectContents {
        ctx: u16,
        map: SelectMap,
    },
    OpenSelectContents {
        ctx: u16,
        file_type: FileReferenceType,
        url: BString,
        map: SelectMap,
    },
    Close {
        ctx: u16,
    },
}

The set of messages used for accessing files on a shared file system or network so they can be used to play sounds without transferring the file contents. Used by UniversalNonRealTimeMsg::FileReference.

As defined in CA-018.

Variants

Open

Fields

ctx: u16

A number 0-16383 used to distinguish between multiple file operations on the same device

file_type: FileReferenceType

url: BString

Max 260 character url.

Describe where a file is located for opening, but must be followed by a SelectContents message if any sounds are to play.

SelectContents

Fields

ctx: u16

A number 0-16383 used to distinguish between multiple file operations on the same device

map: SelectMap

How to map the file’s sounds onto MIDI banks/programs.

Given the pointer to a file, prepare it so its sounds can be loaded.

OpenSelectContents

Fields

ctx: u16

A number 0-16383 used to distinguish between multiple file operations on the same device

file_type: FileReferenceType

url: BString

Max 260 character url.

map: SelectMap

How to map the file’s sounds onto MIDI banks/programs.

The equivalent of an Open and SelectContents messages in succession.

Close

Fields

ctx: u16

A number 0-16383 used to distinguish between multiple file operations on the same device

Close the file and deallocate the data related to it, such that its sounds should no longer play.

Trait Implementations

impl Clone for FileReferenceMsg

fn clone(&self) -> FileReferenceMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileReferenceMsg

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

Formats the value using the given formatter.

impl PartialEq<FileReferenceMsg> for FileReferenceMsg

fn eq(&self, other: &FileReferenceMsg) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FileReferenceMsg

impl StructuralEq for FileReferenceMsg

impl StructuralPartialEq for FileReferenceMsg