Struct SHMediaItem

Source

pub struct SHMediaItem { /* private fields */ }

Available on crate feature SHMediaItem only.

Expand description

An object that represents the metadata for a reference signature.

This class uses subscripting for the data elements of a custom media item that an existing property doesn’t already represent.

Add a readable custom property by extending SHMediaItemProperty-struct with a key for that property, and by extending this class with a property that uses the key. The following code shows the extensions for an episode number:

// Add an episode number to the list of properties.
extension SHMediaItemProperty {
static let episode = SHMediaItemProperty("Episode")
}

// Add a property for returning the episode number using a subscript.
extension SHMediaItem {
var episode: Int? {
return self[.episode] as? Int
}
}

Add your custom property when you create the media item as the following code shows:

// Create a new media item and set the title, subtitle, and episode properties.
let mediaItem = SHMediaItem(properties: [.episode: 42,
.title: "Question",
.subtitle: "The Answer"])

Note: The class of the object that represents a custom object must be one of: Dictionary, Array, URL, Number, String, Date, or Data.

Implementations§

Source §

impl SHMediaItem

Source

pub unsafe fn shazamID(&self) -> Option<Retained<NSString>>

The Shazam ID for the song.

Source

pub unsafe fn title(&self) -> Option<Retained<NSString>>

A title for the media item.

Source

pub unsafe fn subtitle(&self) -> Option<Retained<NSString>>

A subtitle for the media item.

Source

pub unsafe fn artist(&self) -> Option<Retained<NSString>>

The name of the artist for the media item, such as the performer of a song.

Source

pub unsafe fn genres(&self) -> Retained<NSArray<NSString>>

An array of genre names for the media item.

The array is empty if there are no media items.

Source

pub unsafe fn appleMusicID(&self) -> Option<Retained<NSString>>

The Apple Music ID for the song.

Source

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

A link to the Apple Music page that contains the full information for the song.

Source

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

A link to the Shazam Music catalog page that contains the full information for the song.

This link opens the Shazam app or App Clip if it’s available on the device.

Source

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

The URL for artwork for the media item, such as an album cover.

Source

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

The URL for a video for the media item, such as a music video.

Source

pub unsafe fn explicitContent(&self) -> bool

A Boolean value that indicates whether the media item contains explicit content.

Source

pub unsafe fn isrc(&self) -> Option<Retained<NSString>>

The International Standard Recording Code (ISRC) for the media item.

Source

pub unsafe fn timeRanges(&self) -> Retained<NSArray<SHRange>>

Available on crate feature SHRange only.

An array of ranges that indicate the offsets within the reference signature that this media item describes.

Source

pub unsafe fn frequencySkewRanges(&self) -> Retained<NSArray<SHRange>>

Available on crate feature SHRange only.

An array of ranges that indicate the frequency skews in the reference signature that this media item describes.

Source

pub unsafe fn creationDate(&self) -> Option<Retained<NSDate>>

The date the media item was created.

Source

pub unsafe fn mediaItemWithProperties( properties: &NSDictionary<SHMediaItemProperty, AnyObject>, ) -> Retained<Self>

Creates a media item object with a dictionary of properties and their associated values.

Parameters:
properties: A dictionary that contains the media item properties and their associated values.

§Safety

properties generic should be of the correct type.

Source

pub unsafe fn fetchMediaItemWithShazamID_completionHandler( shazam_id: &NSString, completion_handler: &DynBlock<dyn Fn(mut SHMediaItem, mut NSError)>, )

Available on crate feature block2 only.

Requests the media item for the song with the specified Shazam ID.

Important: You can call this method from synchronous code using a completion handler, as shown on this page, or you can call it as an asynchronous method that has the following declaration:
class func fetch(shazamID: String) async throws -> SHMediaItem
For information about concurrency and asynchronous code in Swift, see <doc ://com.apple.documentation/documentation/swift/calling-objective-c-apis-asynchronously>.

Parameters:
shazamID: The Shazam ID of the song.
completionHandler: The completion handler that the system calls with the result of the request.

This block takes the following parameters:

term mediaItem: A media item.
term error: An error object if a problem occurs when fetching the media item; otherwise, nil.

§Safety

completion_handler block must be sendable.

Source

pub unsafe fn valueForProperty( &self, property: &SHMediaItemProperty, ) -> Retained<AnyObject>

Accesses the property for the specified key for reading.

Parameters:
property: The key for the property.
Returns: The value of the property; otherwise, nil.

Source

pub unsafe fn objectForKeyedSubscript( &self, key: &SHMediaItemProperty, ) -> Retained<AnyObject>

Accesses the property for the specified key for reading.

Parameters:
key: The key for the media item property.
Returns: The value of the property; otherwise, nil.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}