GCKMediaMetadata クラス

GCKMediaMetadata クラス リファレンス

概要

メディア メタデータのコンテナ。

メタデータには、メディアタイプ、画像の省略可能なリスト、メタデータ フィールドのコレクションがあります。一般的なメタデータ フィールドのキーは定数として事前定義されていますが、アプリケーションは独自の追加フィールドを自由に定義して使用できます。

事前定義されたフィールドの値には、事前定義された型があります。たとえば、トラック番号は NSInteger で、作成日は日付と時刻の ISO-8601 表現を含む NSString です。フィールドに間違った型の値を保存しようとすると、NSInvalidArgumentException が発生します。

Cast プロトコルでは、特定のメディアタイプで使用できるメタデータ フィールドが制限されています。MediaMetadata オブジェクトが JSON にシリアル化されて Cast レシーバに配信される場合、特定のメディアタイプでサポートされていない事前定義フィールドはシリアル化された形式に含まれませんが、アプリ定義フィールドは常に含まれます。事前定義されたフィールドの完全なリストは次のとおりです。

フィールド 値の型有効なメタデータの種類
kGCKMetadataKeyCreationDate NSDate GCKMediaMetadataTypePhoto
kGCKMetadataKeyReleaseDate NSDate GCKMediaMetadataTypeGenericGCKMediaMetadataTypeMovieGCKMediaMetadataTypeTVShowGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyBroadcastDate NSDate GCKMediaMetadataTypeTVShow
kGCKMetadataKeyTitle NSString GCKMediaMetadataTypeGenericGCKMediaMetadataTypeMovieGCKMediaMetadataTypeTVShowGCKMediaMetadataTypeMusicTrackGCKMediaMetadataTypePhoto
kGCKMetadataKeySubtitle NSString GCKMediaMetadataTypeGenericGCKMediaMetadataTypeMovie
kGCKMetadataKeyArtist NSString GCKMediaMetadataTypeGenericGCKMediaMetadataTypeMusicTrackGCKMediaMetadataTypePhoto
kGCKMetadataKeyAlbumArtist NSString GCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyAlbumTitle NSString GCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyComposer NSString GCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyDiscNumber NSInteger GCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyTrackNumber NSInteger GCKMediaMetadataTypeMusicTrack
kGCKMetadataKeySeasonNumber NSInteger GCKMediaMetadataTypeTVShow
kGCKMetadataKeyEpisodeNumber NSInteger GCKMediaMetadataTypeTVShow
kGCKMetadataKeySeriesTitle NSString GCKMediaMetadataTypeTVShow
kGCKMetadataKeyStudio NSString GCKMediaMetadataTypeMovie
kGCKMetadataKeyWidth NSInteger GCKMediaMetadataTypePhoto
kGCKMetadataKeyHeight NSInteger GCKMediaMetadataTypePhoto
kGCKMetadataKeyLocationName NSString GCKMediaMetadataTypePhoto
kGCKMetadataKeyLocationLatitude double GCKMediaMetadataTypePhoto
kGCKMetadataKeyLocationLongitude double GCKMediaMetadataTypePhoto

NSObject を継承します。<NSCopying> を実装します。

インスタンス メソッドの概要

(instancetype) - initWithMetadataType:
 指定されたメディアタイプで、新しい空の MediaMetadata を初期化します。詳細...
 
(instancetype) - init
 汎用メタデータ型で初期化します。詳細...
 
(GCKMediaMetadataType- metadataType
 メタデータのタイプ。詳細...
 
(NSArray *) - images
 画像のリストを取得します。詳細...
 
(void) - removeAllMediaImages
 現在の画像をすべて削除します。詳細...
 
(void) - addImage:
 画像のリストに画像を追加します。詳細...
 
(BOOL) - containsKey:
 オブジェクトに指定されたキーを持つフィールドが含まれているかどうかをテストします。詳細...
 
(NSArray< NSString * > *) - allKeys
 オブジェクトに存在するすべてのフィールドのキーのセットを返します。詳細...
 
(id __nullable) - objectForKey:
 フィールドの値を読み取ります。詳細...
 
(void) - setString:forKey:
 文字列フィールドに値を保存します。詳細...
 
(NSString *__nullable) - stringForKey:
 文字列フィールドの値を読み取ります。詳細...
 
(void) - setInteger:forKey:
 整数フィールドに値を格納します。詳細...
 
(NSInteger) - integerForKey:
 整数フィールドの値を読み取ります。詳細...
 
(NSInteger) - integerForKey:defaultValue:
 整数フィールドの値を読み取ります。詳細...
 
(void) - setDouble:forKey:
 double フィールドに値を保存します。詳細...
 
(double) - doubleForKey:
 double フィールドの値を読み取ります。詳細...
 
(double) - doubleForKey:defaultValue:
 double フィールドの値を読み取ります。詳細...
 
(void) - setDate:forKey:
 日付フィールドの値を、日付の制限付き ISO-8601 表現として保存します。詳細...
 
(NSDate *__nullable) - dateForKey:
 日付の制限付き ISO-8601 表現から日付フィールドの値を読み取ります。詳細...
 
(NSString *__nullable) - dateAsStringForKey:
 日付フィールドの値を文字列として読み取ります。詳細...
 

公開属性

NSString *const kGCKMetadataKeyCreationDate
 文字列キー: 作成日。詳細...
 
NSString *const kGCKMetadataKeyReleaseDate
 文字列キー: リリース日。詳細...
 
NSString *const kGCKMetadataKeyBroadcastDate
 文字列キー: 配信日。詳細...
 
NSString *const kGCKMetadataKeyTitle
 文字列キー: タイトル。詳細...
 
NSString *const kGCKMetadataKeySubtitle
 文字列キー: Subtitle。詳細...
 
NSString *const kGCKMetadataKeyArtist
 文字列キー: アーティスト。詳細...
 
NSString *const kGCKMetadataKeyAlbumArtist
 文字列キー: アルバム アーティスト。詳細...
 
NSString *const kGCKMetadataKeyAlbumTitle
 文字列キー: アルバムのタイトル。詳細...
 
NSString *const kGCKMetadataKeyComposer
 文字列キー: Composer。詳細...
 
NSString *const kGCKMetadataKeyDiscNumber
 整数キー: ディスク番号。詳細...
 
NSString *const kGCKMetadataKeyTrackNumber
 整数キー: トラック番号。詳細...
 
NSString *const kGCKMetadataKeySeasonNumber
 整数キー: シーズン番号。詳細...
 
NSString *const kGCKMetadataKeyEpisodeNumber
 整数キー: エピソード番号。詳細...
 
NSString *const kGCKMetadataKeySeriesTitle
 文字列キー: シリーズのタイトル。詳細...
 
NSString *const kGCKMetadataKeyStudio
 文字列キー: Studio。詳細...
 
NSString *const kGCKMetadataKeyWidth
 整数キー: 幅。詳細...
 
NSString *const kGCKMetadataKeyHeight
 整数キー: 高さ。詳細...
 
NSString *const kGCKMetadataKeyLocationName
 文字列キー: 位置情報名。詳細...
 
NSString *const kGCKMetadataKeyLocationLatitude
 Double キー: 位置情報の緯度。詳細...
 
NSString *const kGCKMetadataKeyLocationLongitude
 Double キー: 位置の経度。詳細...
 

プロパティの概要

GCKMediaMetadataType metadataType
 メタデータのタイプ。詳細...
 

メソッドの詳細

- (instancetype) initWithMetadataType: (GCKMediaMetadataType metadataType

指定されたメディアタイプで、新しい空の MediaMetadata を初期化します。

指定イニシャライザ。

Parameters
metadataTypeThe media type; one of the GCKMediaMetadataType constants, or a value greater than or equal to GCKMediaMetadataTypeUser for custom media types.
- (instancetype) init

汎用メタデータ型で初期化します。

- (GCKMediaMetadataType) metadataType

メタデータのタイプ。

- (NSArray *) images

画像のリストを取得します。

- (void) removeAllMediaImages

現在の画像をすべて削除します。

- (void) addImage: (GCKImage *)  image

画像のリストに画像を追加します。

Parameters
imageThe image to add.
- (BOOL) containsKey: (NSString *)  key

オブジェクトに指定されたキーを持つフィールドが含まれているかどうかをテストします。

Parameters
keyThe key.
戻り値
フィールドが存在する場合は
YES、それ以外の場合は NO
- (NSArray<NSString *> *) allKeys

オブジェクトに存在するすべてのフィールドのキーのセットを返します。

- (id __nullable) objectForKey: (NSString *)  key

フィールドの値を読み取ります。

Parameters
keyThe key for the field.
戻り値
フィールドの値。フィールドが設定されていない場合は nil
- (void) setString: (NSString *)  value
forKey: (NSString *)  key 

文字列フィールドに値を保存します。

Parameters
valueThe new value for the field.
keyThe key for the field.
例外
NSInvalidArgumentExceptionキーが文字列フィールドではない事前定義フィールドを参照している場合。
- (NSString *__nullable) stringForKey: (NSString *)  key

文字列フィールドの値を読み取ります。

Parameters
keyThe key for the field.
戻り値
フィールドの値。フィールドが設定されていない場合は nil
例外
NSInvalidArgumentExceptionキーが文字列フィールドではない事前定義フィールドを参照している場合。
- (void) setInteger: (NSInteger)  value
forKey: (NSString *)  key 

整数フィールドに値を格納します。

Parameters
valueThe new value for the field.
keyThe key for the field.
例外
NSInvalidArgumentExceptionキーが整数フィールドではない事前定義フィールドを参照している場合。
- (NSInteger) integerForKey: (NSString *)  key

整数フィールドの値を読み取ります。

Parameters
keyThe key for the field.
戻り値
フィールドの値。フィールドが設定されていない場合は 0。
例外
NSInvalidArgumentExceptionキーが整数フィールドではない事前定義フィールドを参照している場合。
- (NSInteger) integerForKey: (NSString *)  key
defaultValue: (NSInteger)  defaultValue 

整数フィールドの値を読み取ります。

Parameters
keyThe key for the field.
defaultValueThe value to return if the field has not been set.
戻り値
フィールドの値。フィールドが設定されていない場合は、指定されたデフォルト値。
例外
NSInvalidArgumentExceptionキーが整数フィールドではない事前定義フィールドを参照している場合。
- (void) setDouble: (double)  value
forKey: (NSString *)  key 

double フィールドに値を保存します。

Parameters
valueThe new value for the field.
keyThe key for the field.
例外
NSInvalidArgumentExceptionキーが double フィールドではない事前定義フィールドを参照している場合。
- (double) doubleForKey: (NSString *)  key

double フィールドの値を読み取ります。

Parameters
keyThe key for the field.
戻り値
フィールドの値。フィールドが設定されていない場合は 0。
例外
NSInvalidArgumentExceptionキーが double フィールドではない事前定義フィールドを参照している場合。
- (double) doubleForKey: (NSString *)  key
defaultValue: (double)  defaultValue 

double フィールドの値を読み取ります。

Parameters
defaultValueThe value to return if the field has not been set.
keyThe key for the field.
戻り値
フィールドの値。フィールドが設定されていない場合は、指定されたデフォルト値。
例外
NSInvalidArgumentExceptionキーが double フィールドではない事前定義フィールドを参照している場合。
- (void) setDate: (NSDate *)  date
forKey: (NSString *)  key 

日付フィールドの値を、日付の制限付き ISO-8601 表現として保存します。

Parameters
dateThe new value for the field.
keyThe key for the field.
例外
NSInvalidArgumentExceptionキーが日付フィールドではない事前定義フィールドを参照している場合。
- (NSDate *__nullable) dateForKey: (NSString *)  key

日付の制限付き ISO-8601 表現から日付フィールドの値を読み取ります。

Parameters
keyThe field name.
戻り値
日付。このフィールドが設定されていない場合は nil
例外
NSInvalidArgumentExceptionキーが日付フィールドではない事前定義フィールドを参照している場合。
- (NSString *__nullable) dateAsStringForKey: (NSString *)  key

日付フィールドの値を文字列として読み取ります。

Parameters
keyThe field name.
戻り値
日付を制限付き ISO-8601 形式で表す文字列。このフィールドが設定されていない場合は nil
例外
NSInvalidArgumentExceptionキーが日付フィールドではない事前定義フィールドを参照している場合。

メンバーデータに関するドキュメント

- (NSString* const) kGCKMetadataKeyCreationDate

文字列キー: 作成日。

値は、メディアが作成された日時(ISO-8601 形式)です。たとえば、写真が撮影された日時や、音楽が録音された日時などです。

- (NSString* const) kGCKMetadataKeyReleaseDate

文字列キー: リリース日。

値は、メディアがリリースされた日時(ISO-8601 形式)です。たとえば、映画や音楽アルバムのリリース日などです。

- (NSString* const) kGCKMetadataKeyBroadcastDate

文字列キー: 配信日。

値は、メディアが最初に放送された日時(ISO-8601 形式)です。たとえば、テレビ番組のエピソードが初めて放送された日付などです。

- (NSString* const) kGCKMetadataKeyTitle

文字列キー: タイトル。

メディアのタイトル。たとえば、曲、映画、テレビ番組のエピソードのタイトルなどです。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeySubtitle

文字列キー: Subtitle。

メディアのサブタイトル。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyArtist

文字列キー: アーティスト。

メディアを作成したアーティストの名前。たとえば、ミュージシャン、パフォーマー、写真家の名前などです。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyAlbumArtist

文字列キー: アルバム アーティスト。

アルバムを制作したアーティストの名前。たとえば、DJ ミックスなどのコンピレーション アルバムでは、アルバム アーティストがアルバム内の個々の曲のアーティストと必ずしも同じであるとは限りません。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyAlbumTitle

文字列キー: アルバムのタイトル。

音楽トラックが属するアルバムのタイトル。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyComposer

文字列キー: Composer。

音楽トラックの作曲者の名前。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyDiscNumber

整数キー: ディスク番号。

マルチディスク アルバムで音楽トラックが属するディスク番号(1 から始まる)。

- (NSString* const) kGCKMetadataKeyTrackNumber

整数キー: トラック番号。

アルバム ディスクの音楽トラックのトラック番号。通常、トラック番号は 1 から数えますが、アルバムの冒頭の「隠しトラック」の場合は 0 になることがあります。

- (NSString* const) kGCKMetadataKeySeasonNumber

整数キー: シーズン番号。

テレビ番組のエピソードが属するシーズン番号。通常、シーズン番号は 1 から始まりますが、テレビ シリーズの正式な開始前に放送された「パイロット」エピソードの場合は、この値が 0 になることがあります。

- (NSString* const) kGCKMetadataKeyEpisodeNumber

整数キー: エピソード番号。

テレビ番組の特定のシーズンのエピソード番号。通常、エピソード番号は 1 から始まりますが、最初のシーズンの公式エピソードと見なされない「パイロット」エピソードの場合は、この値が 0 になることがあります。

- (NSString* const) kGCKMetadataKeySeriesTitle

文字列キー: シリーズのタイトル。

シリーズの名前。たとえば、テレビ番組の名前や、関連する音楽アルバムのシリーズの名前などです。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyStudio

文字列キー: Studio。

メディアを制作したレコーディング スタジオの名前。たとえば、映画スタジオや音楽レーベルの名前などです。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyWidth

整数キー: 幅。

メディアの幅(ピクセル単位)。通常、これは写真の寸法を提供するために使用されます。

- (NSString* const) kGCKMetadataKeyHeight

整数キー: 高さ。

メディアの高さ(ピクセル単位)。通常、これは写真の寸法を提供するために使用されます。

- (NSString* const) kGCKMetadataKeyLocationName

文字列キー: 場所の名前。

メディアが作成されたビジネスの名前。たとえば、写真の撮影場所や映画の主な撮影場所などです。この値は表示目的に適しています。

- (NSString* const) kGCKMetadataKeyLocationLatitude

Double キー: 位置情報の緯度。

メディアが作成された地理的位置の緯度コンポーネント。たとえば、写真の撮影場所や映画の主な撮影場所などです。

- (NSString* const) kGCKMetadataKeyLocationLongitude

Double キー: 位置情報の経度。

メディアが作成された地理的位置の経度コンポーネント。たとえば、写真の撮影場所や映画の主な撮影場所などです。

プロパティの詳細

- (GCKMediaMetadataType) metadataType
readnonatomicassign

メタデータのタイプ。