Struct reaper_medium::OwnedPcmSource

source · [−]

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

Expand description

Owned PCM source.

This PCM source automatically destroys the associated C++ PCM_source when dropped.

Implementations

source

impl OwnedPcmSource

source

pub unsafe fn from_raw(raw: PcmSource) -> Self

Takes ownership of the given source.

Safety

You must guarantee that the given source is currently owner-less, otherwise double-free or use-after-free can occur.

source

pub unsafe fn leak(self) -> PcmSource

Returns the inner pointer without destroying the source.

Safety

You can run into a memory leak or crash if you don’t manage the lifetime of the returned source correctly.

Methods from Deref<Target = BorrowedPcmSource>

source

pub fn as_ptr(&self) -> PcmSource

Returns the pointer to this source.

source

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

Duplicates this source.

source

pub fn is_available(&self) -> bool

Returns if this source is available.

source

pub fn set_available(&self, available: bool)

If called with false, closes files etc.

source

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.

source

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

Returns the type of this source.

Safety

Returned string’s lifetime is unbounded.

source

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.

source

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.

source

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

Returns true if supported. Only call when offline.

source

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

Returns the parent source, if any.

source

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

source

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

Returns number of channels.

source

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

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

source

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.

source

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

Returns length in beats if supported.

source

pub fn get_bits_per_sample(&self) -> u32

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

source

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

Returns None if not supported.

source

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

Unstable!!!

Safety

REAPER can crash if you pass an invalid pointer.

source

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

Unstable!!!

Safety

API still unstable.

source

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

Unstable!!!

Safety

API still unstable.

source

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

Unstable!!!

Safety

API still unstable.

source

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

Unstable!!!

Safety

API still unstable.

source

pub fn peaks_clear(&self, delete_file: bool)

Builds peaks for files.

source

pub fn peaks_build_begin(&self) -> bool

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

source

pub fn peaks_build_run(&self) -> bool

Returns true if building should continue.

source

pub fn peaks_build_finish(&self)

Call when done.

source

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.

source

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.

source

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.

source

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

Unpools the MIDI in this source.

Errors

Returns an error if not supported.

source

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.

source

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

source

impl AsMut<BorrowedPcmSource> for OwnedPcmSource

source

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

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

source

impl AsRef<BorrowedPcmSource> for OwnedPcmSource

source

fn as_ref(&self) -> &BorrowedPcmSource

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

source

impl Borrow<BorrowedPcmSource> for OwnedPcmSource

source

fn borrow(&self) -> &BorrowedPcmSource

Immutably borrows from an owned value. Read more

source

impl Clone for OwnedPcmSource

source

fn clone(&self) -> OwnedPcmSource

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for OwnedPcmSource

source

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

Formats the value using the given formatter. Read more

source

impl Deref for OwnedPcmSource

type Target = BorrowedPcmSource

The resulting type after dereferencing.

source

fn deref(&self) -> &BorrowedPcmSource

Dereferences the value.

source

impl DerefMut for OwnedPcmSource

source

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

Mutably dereferences the value.

source

impl Drop for OwnedPcmSource

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl Hash for OwnedPcmSource

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<OwnedPcmSource> for OwnedPcmSource

source

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

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

1.0.0 · source

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. Read more

source

impl StructuralPartialEq for OwnedPcmSource

Auto Trait Implementations

impl RefUnwindSafe for OwnedPcmSource

impl !Sync for OwnedPcmSource

impl Unpin for OwnedPcmSource

impl UnwindSafe for OwnedPcmSource

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for Twhere
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct reaper_medium::OwnedPcmSource

Implementations

impl OwnedPcmSource

pub unsafe fn from_raw(raw: PcmSource) -> Self

pub unsafe fn leak(self) -> PcmSource

Methods from Deref<Target = BorrowedPcmSource>

pub fn as_ptr(&self) -> PcmSource

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

pub fn is_available(&self) -> bool

pub fn set_available(&self, available: bool)

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

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

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

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

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

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

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

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

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

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

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

pub fn get_bits_per_sample(&self) -> u32

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

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

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

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

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

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

pub fn peaks_clear(&self, delete_file: bool)

pub fn peaks_build_begin(&self) -> bool

pub fn peaks_build_run(&self) -> bool

pub fn peaks_build_finish(&self)

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

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

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

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

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

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

Trait Implementations

impl AsMut<BorrowedPcmSource> for OwnedPcmSource

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

impl AsRef<BorrowedPcmSource> for OwnedPcmSource

fn as_ref(&self) -> &BorrowedPcmSource

impl Borrow<BorrowedPcmSource> for OwnedPcmSource

fn borrow(&self) -> &BorrowedPcmSource

impl Clone for OwnedPcmSource

fn clone(&self) -> OwnedPcmSource

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

impl Debug for OwnedPcmSource

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

impl Deref for OwnedPcmSource

type Target = BorrowedPcmSource

fn deref(&self) -> &BorrowedPcmSource

impl DerefMut for OwnedPcmSource

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

impl Drop for OwnedPcmSource

fn drop(&mut self)

impl Hash for OwnedPcmSource

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

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

impl PartialEq<OwnedPcmSource> for OwnedPcmSource

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

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

impl Eq for OwnedPcmSource

impl Send for OwnedPcmSource

impl StructuralEq for OwnedPcmSource

impl StructuralPartialEq for OwnedPcmSource

Auto Trait Implementations

impl RefUnwindSafe for OwnedPcmSource

impl !Sync for OwnedPcmSource

impl Unpin for OwnedPcmSource

impl UnwindSafe for OwnedPcmSource

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for Twhere T: Any,

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

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

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

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

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

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

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Downcast for Twhere
T: Any,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,