Struct AVAudioRecorder 

pub struct AVAudioRecorder { /* private fields */ }

Available on crate feature AVAudioRecorder only.

An object that records audio data to a file.

See also Apple’s documentation

Implementations

impl AVAudioRecorder

pub unsafe fn initWithURL_settings_error( this: Allocated<Self>, url: &NSURL, settings: &NSDictionary<NSString, AnyObject>, ) -> Result<Retained<Self>, Retained<NSError>>

Init the AudioRecorder with a specified url and settings.

The file type to create can be set through the corresponding settings key. If not set, it will be inferred from the file extension. Will overwrite a file at the specified url if a file exists.

Safety

settings generic should be of the correct type.

pub unsafe fn initWithURL_format_error( this: Allocated<Self>, url: &NSURL, format: &AVAudioFormat, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature AVAudioFormat only.

Init the AudioRecorder with a specified url and format.

The file type to create can be set through the corresponding settings key. If not set, it will be inferred from the file extension. Will overwrite a file at the specified url if a file exists.

pub unsafe fn prepareToRecord(&self) -> bool

Creates the output file and gets ready to record.

This method is called automatically on record. Returns YES on success and NO on failure.

pub unsafe fn record(&self) -> bool

Start or resume recording to file.

Returns YES on success and NO on failure.

pub unsafe fn recordAtTime(&self, time: NSTimeInterval) -> bool

Start recording at specified time in the future.

Time is an absolute time based on and greater than deviceCurrentTime. Returns YES on success and NO on failure.

pub unsafe fn recordForDuration(&self, duration: NSTimeInterval) -> bool

Record for a specified duration.

The recorder will stop when it has recorded this length of audio. Returns YES on success and NO on failure.

pub unsafe fn recordAtTime_forDuration( &self, time: NSTimeInterval, duration: NSTimeInterval, ) -> bool

Record for a specified duration at a specified time in the future.

Time is an absolute time based on and greater than deviceCurrentTime. Returns YES on success and NO on failure.

pub unsafe fn pause(&self)

Pause recording.

pub unsafe fn stop(&self)

Stop recording.

This method also closes the output file.

pub unsafe fn deleteRecording(&self) -> bool

Delete the recorded file.

AudioRecorder must be stopped. Returns YES on success and NO on failure.

pub unsafe fn isRecording(&self) -> bool

Returns YES if the AudioRecorder is currently recording.

pub unsafe fn url(&self) -> Retained<NSURL>

URL of the recorded file.

pub unsafe fn settings(&self) -> Retained<NSDictionary<NSString, AnyObject>>

A dictionary of settings for the AudioRecorder.

These settings are fully valid only when prepareToRecord has been called. For supported key-value pairs, see https://developer.apple.com/documentation/avfaudio/avaudiorecorder/1388386-initwithurl?language=objc

pub unsafe fn format(&self) -> Retained<AVAudioFormat>

Available on crate feature AVAudioFormat only.

The audio format of the AudioRecorder.

This property is fully valid only when prepareToRecord has been called.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn AVAudioRecorderDelegate>>>

A delegate object to the AudioRecorder that conforms to the AVAudioRecorderDelegate protocol.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn AVAudioRecorderDelegate>>, )

Setter for delegate.

This is a weak property.

pub unsafe fn currentTime(&self) -> NSTimeInterval

Get the current time of the recording.

This method is only vaild while recording.

pub unsafe fn deviceCurrentTime(&self) -> NSTimeInterval

Get the device current time.

This method is always valid.

pub unsafe fn isMeteringEnabled(&self) -> bool

Turns level metering on or off.

Default is off.

pub unsafe fn setMeteringEnabled(&self, metering_enabled: bool)

Setter for isMeteringEnabled.

pub unsafe fn updateMeters(&self)

Call this method to refresh meter values.

pub unsafe fn peakPowerForChannel(&self, channel_number: NSUInteger) -> c_float

Returns peak power in decibels for a given channel.

pub unsafe fn averagePowerForChannel( &self, channel_number: NSUInteger, ) -> c_float

Returns average power in decibels for a given channel.

pub unsafe fn channelAssignments( &self, ) -> Option<Retained<NSArray<AVAudioSessionChannelDescription>>>

Available on crate feature AVAudioSessionRoute only.

Array of AVAudioSessionChannelDescription objects

The channels property lets you assign the output to record specific channels as described by AVAudioSessionPortDescription’s channels property. This property is nil valued until set. The array must have the same number of channels as returned by the numberOfChannels property.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setChannelAssignments( &self, channel_assignments: Option<&NSArray<AVAudioSessionChannelDescription>>, )

Available on crate feature AVAudioSessionRoute only.

Setter for channelAssignments.

This is copied when set.

Safety

This might not be thread-safe.

impl AVAudioRecorder

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AVAudioRecorder> for AVAudioRecorder

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVAudioRecorder

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVAudioRecorder

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for AVAudioRecorder

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVAudioRecorder

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVAudioRecorder

const NAME: &'static str = "AVAudioRecorder"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<AVAudioRecorder as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for AVAudioRecorder

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

Formats the value using the given formatter.

impl Deref for AVAudioRecorder

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for AVAudioRecorder

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for AVAudioRecorder

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for AVAudioRecorder

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for AVAudioRecorder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RefEncode for AVAudioRecorder

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for AVAudioRecorder

impl Eq for AVAudioRecorder

impl Send for AVAudioRecorder

impl Sync for AVAudioRecorder