Struct reaper_medium::BorrowedPcmSource

#[repr(transparent)]
pub struct BorrowedPcmSource(_);

Borrowed (reference-only) PCM source.

Implementations

impl BorrowedPcmSource

pub fn from_raw(raw: &PCM_source) -> &Self

Creates a medium-level representation from the given low-level reference.

pub fn from_raw_mut(raw: &mut PCM_source) -> &mut Self

Creates a mutable medium-level representation from the given low-level reference.

pub fn as_ptr(&self) -> PcmSource

Returns the pointer to this source.

pub fn duplicate(&self) -> Option<OwnedPcmSource>

Duplicates this source.

pub fn is_available(&self) -> bool

Returns if this source is available.

pub fn set_available(&self, available: bool)

If called with false, closes files etc.

pub fn get_type<R>(&self, use_type: impl FnOnce(&ReaperStr) -> R) -> R

Grants temporary access to the type of this source.

This type should not be empty but if a third-party source provider doesn’t get it right, this can still happen. An empty string is also used as fallback if the third-party source returns a null pointer.

pub unsafe fn get_type_unchecked(&self) -> &ReaperStr

Returns the type of this source.

Safety

Returned string’s lifetime is unbounded.

pub fn get_file_name<R>(&self, use_file: impl FnOnce(Option<&Path>) -> R) -> R

Grants temporary access to the file of this source.

None is a valid result. In that case it’s not purely a file. Takes care of converting an empty path to None.

pub unsafe fn get_file_name_unchecked(&self) -> Option<&ReaperStr>

Returns the file of this source.

None is a valid result. In that case it’s not purely a file. Takes care of converting an empty path to None.

Safety

Returned string’s lifetime is unbounded.

pub fn set_file_name(&self, new_file_name: Option<&Path>) -> bool

Returns true if supported. Only call when offline.

pub fn get_source(&self) -> Option<PcmSource>

Returns the parent source, if any.

pub fn set_source(&self, source: Option<PcmSource>)

pub fn get_num_channels(&self) -> Option<u32>

Returns number of channels.

pub fn get_sample_rate(&self) -> Option<Hz>

Returns preferred sample rate. If None then it is assumed to be silent (or MIDI).

pub fn get_length(&self) -> Result<DurationInSeconds, ReaperFunctionError>

Returns the length of this source.

Errors

Returns an error if this source doesn’t return a valid duration.

pub fn get_length_beats(&self) -> Option<DurationInBeats>

Returns length in beats if supported.

pub fn get_bits_per_sample(&self) -> u32

Returns bits/sample, if available. Only used for metadata purposes, since everything returns as doubles anyway.

pub fn get_preferred_position(&self) -> Option<PositionInSeconds>

Returns None if not supported.

pub unsafe fn properties_window(&self, parent_window: Option<Hwnd>) -> i32

Unstable!!!

Safety

REAPER can crash if you pass an invalid pointer.

pub unsafe fn get_samples(&self, block: &PcmSourceTransfer)

Unstable!!!

Safety

API still unstable.

pub unsafe fn get_peak_info(&self, block: &PcmSourcePeakTransfer)

Unstable!!!

Safety

API still unstable.

pub unsafe fn save_state(&self, context: &BorrowedProjectStateContext)

Unstable!!!

Safety

API still unstable.

pub unsafe fn load_state(
    &self,
    first_line: &ReaperStr,
    context: &BorrowedProjectStateContext
) -> Result<(), Box<dyn Error>>

Unstable!!!

Safety

API still unstable.

pub fn peaks_clear(&self, delete_file: bool)

Builds peaks for files.

pub fn peaks_build_begin(&self) -> bool

Returns true if building is opened, otherwise it may mean building isn’t necessary.

pub fn peaks_build_run(&self) -> bool

Returns true if building should continue.

pub fn peaks_build_finish(&self)

Call when done.

pub unsafe fn extended(
    &self,
    call: i32,
    parm_1: *mut c_void,
    parm_2: *mut c_void,
    parm_3: *mut c_void
) -> i32

Safety

REAPER can crash if you pass invalid pointers.

pub fn ext_get_pooled_midi_id(
    &self
) -> Result<ExtGetPooledMidiIdResult, ReaperFunctionError>

Unstable!!!

If this source represents pooled MIDI data, this will return information about it.

Errors

Returns an error if not supported.

pub fn ext_export_to_file(
    &self,
    file_name: &Path
) -> Result<(), ReaperFunctionError>

Writes the content of this source to the given file.

Only currently supported by MIDI but in theory any source could support this.

Errors

Returns an error if not supported.

pub fn ext_remove_from_midi_pool(&self) -> Result<(), ReaperFunctionError>

Unpools the MIDI in this source.

Errors

Returns an error if not supported.

pub fn ext_set_preview_tempo(
    &self,
    tempo: Option<Bpm>
) -> Result<(), ReaperFunctionError>

Sets the preview tempo for this source.

This will make the source ignore the project tempo.

Setting None will reset IGNTEMPO in REAPER versions >= v6.56+dev0425 or so.

Errors

Returns an error if not supported.

pub unsafe fn ext_open_editor(
    &self,
    hwnd: Hwnd,
    track_index: u32
) -> Result<(), ReaperFunctionError>

Opens the editor for this source.

Errors

Returns an error if not supported.

Safety

REAPER can crash if you pass an invalid window.

Trait Implementations

impl AsMut<BorrowedPcmSource> for CustomOwnedPcmSource

fn as_mut(&mut self) -> &mut BorrowedPcmSource

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<BorrowedPcmSource> for FlexibleOwnedPcmSource

fn as_mut(&mut self) -> &mut BorrowedPcmSource

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<BorrowedPcmSource> for OwnedPcmSource

fn as_mut(&mut self) -> &mut BorrowedPcmSource

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<PCM_source> for BorrowedPcmSource

fn as_mut(&mut self) -> &mut PCM_source

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<BorrowedPcmSource> for CustomOwnedPcmSource

fn as_ref(&self) -> &BorrowedPcmSource

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<BorrowedPcmSource> for FlexibleOwnedPcmSource

fn as_ref(&self) -> &BorrowedPcmSource

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<BorrowedPcmSource> for OwnedPcmSource

fn as_ref(&self) -> &BorrowedPcmSource

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PCM_source> for BorrowedPcmSource

fn as_ref(&self) -> &PCM_source

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<BorrowedPcmSource> for OwnedPcmSource

fn borrow(&self) -> &BorrowedPcmSource

Immutably borrows from an owned value.

impl Debug for BorrowedPcmSource

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

Formats the value using the given formatter.

impl Hash for BorrowedPcmSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<BorrowedPcmSource> for BorrowedPcmSource

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

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

const 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 RefCast for BorrowedPcmSource

type From = PCM_source

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl ToOwned for BorrowedPcmSource

type Owned = OwnedPcmSource

The resulting type after obtaining ownership.

fn to_owned(&self) -> OwnedPcmSource

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for BorrowedPcmSource

impl StructuralEq for BorrowedPcmSource

impl StructuralPartialEq for BorrowedPcmSource