概要
メディア メタデータのコンテナです。
メタデータには、メディアタイプ、画像のリスト（オプション）、メタデータ フィールドのコレクションがあります。一般的なメタデータ フィールドのキーは定数として事前定義されていますが、アプリケーションは独自のフィールドを追加で自由に定義して使用できます。
事前定義されたフィールドの値は、事前定義されたタイプを持ちます。たとえば、トラック番号は NSInteger で、作成日は ISO-8601 で表現した日付と時刻の NSString です。間違った型の値をフィールドに保存しようとすると、NSInvalidArgumentException が発生します。
Cast プロトコルにより、特定のメディアタイプで使用できるメタデータ フィールドが制限されていることにご注意ください。キャスト レシーバーに配信するために MediaMetadata オブジェクトを JSON にシリアル化する場合、特定のメディアタイプでサポートされていない事前定義済みフィールドはシリアル化された形式に含まれませんが、アプリケーション定義のフィールドは常に含まれます。事前定義フィールドの完全なリストは次のとおりです。
NSObject、<NSCopying>、<NSSecureCoding> を継承します。
インスタンス メソッドの概要 | |
| (instancetype) | - initWithMetadataType: |
| 指定されたメディアタイプで、新しい空の MediaMetadata を初期化します。その他... | |
| (instancetype) | - init |
| 汎用メタデータ型で初期化します。その他... | |
| (GCKMediaMetadataType) | - metadataType |
| メタデータのタイプ。その他... | |
| (NSArray *) | - images |
| イメージのリストを取得します。その他... | |
| (void) | - removeAllMediaImages |
| 現在の画像をすべて削除します。その他... | |
| (void) | - addImage: |
| 画像のリストに画像を追加します。その他... | |
| (BOOL) | - containsKey: |
| 指定されたキーを持つフィールドがオブジェクトに含まれているかどうかをテストします。その他... | |
| (NSArray< NSString * > *) | - allKeys |
| オブジェクトに存在するすべてのフィールドのキーのセットを返します。その他... | |
| (nullable id) | - objectForKey: |
| フィールドの値を読み取ります。その他... | |
| (void) | - setString:forKey: |
| 文字列フィールドに値を保存します。その他... | |
| (nullable NSString *) | - 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 表現として日付フィールドに値を保存します。その他... | |
| (nullable NSDate *) | - dateForKey: |
| 制限された日付の ISO-8601 表現から日付フィールドの値を読み取ります。その他... | |
| (nullable NSString *) | - dateAsStringForKey: |
| 日付フィールドの値を文字列として読み取ります。その他... | |
プロパティの概要 | |
| GCKMediaMetadataType | metadataType |
| メタデータのタイプ。その他... | |
メソッドの詳細
| - (instancetype) initWithMetadataType: | (GCKMediaMetadataType) | metadataType |
指定されたメディアタイプで、新しい空の MediaMetadata を初期化します。
指定のイニシャライザ。
- Parameters
-
metadataType The 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
-
image The image to add.
| - (BOOL) containsKey: | (NSString *) | key |
指定されたキーを持つフィールドがオブジェクトに含まれているかどうかをテストします。
- Parameters
-
key The key.
- 戻り値
- フィールドが存在する場合は
YES、存在しない場合はNO。
| - (NSArray<NSString *> *) allKeys |
オブジェクトに存在するすべてのフィールドのキーのセットを返します。
| - (nullable id) objectForKey: | (NSString *) | key |
フィールドの値を読み取ります。
- Parameters
-
key The key for the field.
- 戻り値
- フィールドの値。フィールドが設定されていない場合は
nil。
| - (void) setString: | (NSString *) | value | |
| forKey: | (NSString *) | key | |
文字列フィールドに値を保存します。
- Parameters
-
value The new value for the field. key The key for the field.
- 例外
-
NSInvalidArgumentException キーが、文字列フィールドではない事前定義フィールドを参照している場合。
| - (nullable NSString *) stringForKey: | (NSString *) | key |
文字列フィールドの値を読み取ります。
- Parameters
-
key The key for the field.
- 戻り値
- フィールドの値。フィールドが設定されていない場合は
nil。
- 例外
-
NSInvalidArgumentException キーが、文字列フィールドではない事前定義フィールドを参照している場合。
| - (void) setInteger: | (NSInteger) | value | |
| forKey: | (NSString *) | key | |
整数フィールドに値を保存します。
- Parameters
-
value The new value for the field. key The key for the field.
- 例外
-
NSInvalidArgumentException キーが整数フィールドではない事前定義済みフィールドを参照している場合
| - (NSInteger) integerForKey: | (NSString *) | key |
整数フィールドの値を読み取ります。
- Parameters
-
key The key for the field.
- 戻り値
- フィールドの値。フィールドが設定されていない場合は 0。
- 例外
-
NSInvalidArgumentException キーが整数フィールドではない事前定義済みフィールドを参照している場合
| - (NSInteger) integerForKey: | (NSString *) | key | |
| defaultValue: | (NSInteger) | defaultValue | |
整数フィールドの値を読み取ります。
- Parameters
-
key The key for the field. defaultValue The value to return if the field has not been set.
- 戻り値
- フィールドの値、またはフィールドが設定されていない場合は指定されたデフォルト値。
- 例外
-
NSInvalidArgumentException キーが整数フィールドではない事前定義済みフィールドを参照している場合
| - (void) setDouble: | (double) | value | |
| forKey: | (NSString *) | key | |
double フィールドに値を保存します。
- Parameters
-
value The new value for the field. key The key for the field.
- 例外
-
NSInvalidArgumentException キーが double フィールド以外の事前定義済みフィールドを参照している場合。
| - (double) doubleForKey: | (NSString *) | key |
double フィールドの値を読み取ります。
- Parameters
-
key The key for the field.
- 戻り値
- フィールドの値。フィールドが設定されていない場合は 0。
- 例外
-
NSInvalidArgumentException キーが double フィールド以外の事前定義済みフィールドを参照している場合。
| - (double) doubleForKey: | (NSString *) | key | |
| defaultValue: | (double) | defaultValue | |
double フィールドの値を読み取ります。
- Parameters
-
defaultValue The value to return if the field has not been set. key The key for the field.
- 戻り値
- フィールドの値、またはフィールドが設定されていない場合は指定されたデフォルト値。
- 例外
-
NSInvalidArgumentException キーが double フィールド以外の事前定義済みフィールドを参照している場合。
| - (void) setDate: | (NSDate *) | date | |
| forKey: | (NSString *) | key | |
日付の制限付き ISO-8601 表現として日付フィールドに値を保存します。
- Parameters
-
date The new value for the field. key The key for the field.
- 例外
-
NSInvalidArgumentException キーが日付フィールドではない事前定義済みフィールドを参照している場合
| - (nullable NSDate *) dateForKey: | (NSString *) | key |
制限された日付の ISO-8601 表現から日付フィールドの値を読み取ります。
- Parameters
-
key The field name.
- 戻り値
- 日付、またはこのフィールドが設定されていない場合は
nil。
- 例外
-
NSInvalidArgumentException キーが日付フィールドではない事前定義済みフィールドを参照している場合
| - (nullable NSString *) dateAsStringForKey: | (NSString *) | key |
日付フィールドの値を文字列として読み取ります。
- Parameters
-
key The field name.
- 戻り値
- 日付の制限付き ISO-8601 表現を含む文字列の日付。このフィールドが設定されていない場合は
nil。
- 例外
-
NSInvalidArgumentException キーが日付フィールドではない事前定義済みフィールドを参照している場合
メンバーデータに関するドキュメント
| - (NSString* const) kGCKMetadataKeyCreationDate |
文字列キー: 作成日。
この値は、メディアが作成された日時（ISO-8601 形式）です。たとえば、写真の撮影日時や楽曲が録音された日時などが考えられます。
| - (NSString* const) kGCKMetadataKeyReleaseDate |
文字列キー: リリース日。
この値は、メディアがリリースされた日付や時刻（ISO-8601 形式）です。たとえば、映画や音楽のアルバムがリリースされた日付などが考えられます。
| - (NSString* const) kGCKMetadataKeyBroadcastDate |
文字列キー: 配信日。
この値は、メディアが最初にブロードキャストされた日付や時刻（ISO-8601 形式）です。たとえば、テレビ番組のエピソードが最初に放送された日付などです。
| - (NSString* const) kGCKMetadataKeyTitle |
文字列キー: Title。
メディアのタイトル。たとえば、曲、映画、テレビ番組のエピソードのタイトルなどです。この値は表示に適しています。
| - (NSString* const) kGCKMetadataKeySubtitle |
文字列キー: サブタイトル。
メディアのサブタイトル。この値は表示に適しています。
| - (NSString* const) kGCKMetadataKeyArtist |
文字列キー: Artist。
メディアを作成したアーティストの名前。たとえば、ミュージシャン、パフォーマー、写真家の名前などを指定できます。この値は表示に適しています。
| - (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 |
ダブルキー: 場所の緯度。
メディアが作成された地理的位置の緯度コンポーネント。たとえば、写真の撮影場所や映画の主要な撮影場所などです。
| - (NSString* const) kGCKMetadataKeyLocationLongitude |
ダブルキー: 場所の経度。
メディアが作成された地理的位置の経度コンポーネント。たとえば、写真の撮影場所や映画の主要な撮影場所などです。
| - (NSString* const) kGCKMetadataKeyBookTitle |
文字列キー: 書籍のタイトル。
オーディオブックのタイトル。
- 開始:
- 4.3.5
| - (NSString* const) kGCKMetadataKeyChapterNumber |
整数キー: チャプター番号。
オーディオブックのチャプター番号。
- 開始:
- 4.3.5
| - (NSString* const) kGCKMetadataKeyChapterTitle |
文字列キー: チャプターのタイトル。
オーディオ ブックの章のタイトル。
- 開始:
- 4.3.5
| - (NSString* const) kGCKMetadataKeySectionDuration |
ダブルキー: セクション期間。
セクションの再生時間（秒単位）。キューのメタデータに使用されます。たとえば、キューにあるテレビ番組の長さ、オーディオ ブックのチャプターの長さ、長いライブ配信の番組などが該当します。
- 開始:
- 4.4.1
| - (NSString* const) kGCKMetadataKeySectionStartTimeInMedia |
ダブルキー: メディアのセクション開始時間。
メディア アイテムの先頭からセクション開始時間のオフセット（秒単位）。キューのメタデータに使用されます。
- 開始:
- 4.4.1
| - (NSString* const) kGCKMetadataKeySectionStartAbsoluteTime |
ダブルキー: セクションの絶対開始時間。
セクション開始の絶対時間（エポック時間（秒単位））。キューのメタデータに使用されます。
- 開始:
- 4.4.1
| - (NSString* const) kGCKMetadataKeySectionStartTimeInContainer |
ダブルキー: コンテナのセクション開始時間。
コンテナ全体におけるセクション開始時間のオフセット。キューのメタデータに使用されます。
- 開始:
- 4.4.1
| - (NSString* const) kGCKMetadataKeyQueueItemID |
ダブルキー: キューアイテム ID。
セクションの開始時間を含むキュー アイテムの ID。キューのメタデータに使用されます。
- 開始:
- 4.4.1
物件の詳細
|
readnonatomicassign |
メタデータのタイプ。