GCKMediaMetadata クラス

GCKMediaMetadata クラス リファレンス

概要

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

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

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

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

フィールド値の型有効なメタデータの種類
kGCKMetadataKeyCreationDate NSDateGCKMediaMetadataTypePhoto
kGCKMetadataKeyReleaseDate NSDateGCKMediaMetadataTypeGenericGCKMediaMetadataTypeMovieGCKMediaMetadataTypeTVShowGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyBroadcastDate NSDateGCKMediaMetadataTypeTVShow
kGCKMetadataKeyTitle NSStringGCKMediaMetadataTypeGenericGCKMediaMetadataTypeMovieGCKMediaMetadataTypeTVShowGCKMediaMetadataTypeMusicTrackGCKMediaMetadataTypePhoto
kGCKMetadataKeySubtitle NSStringGCKMediaMetadataTypeGenericGCKMediaMetadataTypeMovie
kGCKMetadataKeyArtist NSStringGCKMediaMetadataTypeGenericGCKMediaMetadataTypeMusicTrackGCKMediaMetadataTypePhoto
kGCKMetadataKeyAlbumArtist NSStringGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyAlbumTitle NSStringGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyComposer NSStringGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyDiscNumber NSIntegerGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeyTrackNumber NSIntegerGCKMediaMetadataTypeMusicTrack
kGCKMetadataKeySeasonNumber NSIntegerGCKMediaMetadataTypeTVShow
kGCKMetadataKeyEpisodeNumber NSIntegerGCKMediaMetadataTypeTVShow
kGCKMetadataKeySeriesTitle NSStringGCKMediaMetadataTypeTVShow
kGCKMetadataKeyStudio NSStringGCKMediaMetadataTypeMovie
kGCKMetadataKeyWidth NSIntegerGCKMediaMetadataTypePhoto
kGCKMetadataKeyHeight NSIntegerGCKMediaMetadataTypePhoto
kGCKMetadataKeyLocationName NSStringGCKMediaMetadataTypePhoto
kGCKMetadataKeyLocationLatitude ダブルGCKMediaMetadataTypePhoto
kGCKMetadataKeyLocationLongitude ダブルGCKMediaMetadataTypePhoto

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:
 日付フィールドの値を文字列として読み取ります。その他...
 

公開属性

NSString *const kGCKMetadataKeyCreationDate
 文字列キー: 作成日。その他...
 
NSString *const kGCKMetadataKeyReleaseDate
 文字列キー: リリース日。その他...
 
NSString *const kGCKMetadataKeyBroadcastDate
 文字列キー: 配信日。その他...
 
NSString *const kGCKMetadataKeyTitle
 文字列キー: タイトル。その他...
 
NSString *const kGCKMetadataKeySubtitle
 文字列キー: サブタイトル。その他...
 
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 キー: 場所の経度。その他...
 
NSString *const kGCKMetadataKeyBookTitle
 文字列キー: 書籍名。その他...
 
NSString *const kGCKMetadataKeyChapterNumber
 整数キー: チャプター番号。その他...
 
NSString *const kGCKMetadataKeyChapterTitle
 文字列キー: チャプターのタイトル。その他...
 
NSString *const kGCKMetadataKeySectionDuration
 Double キー: セクション所要時間。その他...
 
NSString *const kGCKMetadataKeySectionStartTimeInMedia
 Double キー: メディア内のセクション開始時間。その他...
 
NSString *const kGCKMetadataKeySectionStartAbsoluteTime
 Double キー: セクション絶対開始時間。その他...
 
NSString *const kGCKMetadataKeySectionStartTimeInContainer
 Double キー: コンテナでのセクションの開始時間。その他...
 
NSString *const kGCKMetadataKeyQueueItemID
 Double キー: キューアイテム IDその他...
 

プロパティの概要

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

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

- (nullable id) 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.
例外
NSInvalidAexceptionキーが事前定義された文字列フィールドを参照していて、そのフィールドが文字列フィールドではない場合。
- (nullable NSString *) stringForKey: (NSString *)  key

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

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

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

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

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

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

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

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

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

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

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

Parameters
keyThe key for the field.
戻り値
フィールドの値。フィールドが設定されていない場合は 0。
例外
NSInvalidAexception事前定義されたフィールド(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.
戻り値
フィールドの値。フィールドが設定されていない場合は、指定されたデフォルト値。
例外
NSInvalidAexception事前定義されたフィールド(double フィールドではない)をキーが参照している場合。
- (void) setDate: (NSDate *)  date
forKey: (NSString *)  key 

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

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

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

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

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

Parameters
keyThe field name.
戻り値
日付の限定された ISO-8601 表現を含む文字列としての日付。このフィールドが設定されていない場合は nil になります。
例外
NSInvalidAexceptionキーが日付フィールドではなく、事前定義されたフィールドを参照している場合。

メンバーデータのドキュメント

- (NSString* const) kGCKMetadataKeyCreationDate

文字列キー: 作成日。

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

- (NSString* const) kGCKMetadataKeyReleaseDate

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

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

- (NSString* const) kGCKMetadataKeyBroadcastDate

文字列キー: 配信日。

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

- (NSString* const) kGCKMetadataKeyTitle

文字列キー: タイトル。

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

- (NSString* const) kGCKMetadataKeySubtitle

文字列キー: サブタイトル。

メディアの字幕。この値は表示目的に適しています。

- (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 から始まりますが、第 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 キー: 場所の経度。

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

- (NSString* const) kGCKMetadataKeyBookTitle

文字列キー: 書籍名。

オーディオブックのタイトル。

シンセ
4.3.5
- (NSString* const) kGCKMetadataKeyChapterNumber

整数キー: チャプター番号。

オーディオブックのチャプターの数。

シンセ
4.3.5
- (NSString* const) kGCKMetadataKeyChapterTitle

文字列キー: チャプターのタイトル。

オーディオ ブック内のチャプターのタイトル。

シンセ
4.3.5
- (NSString* const) kGCKMetadataKeySectionDuration

Double キー: セクション所要時間。

セクションの長さ(秒)。キューのメタデータに使用されます。たとえば、キューにある 1 つのテレビ番組の継続時間、オーディオ ブックのチャプターの長さ、長いライブ配信の番組などが該当します。

シンセ
4.4.1
- (NSString* const) kGCKMetadataKeySectionStartTimeInMedia

Double キー: メディア内のセクション開始時間。

メディア アイテムの開始からのセクション開始時間のオフセット(秒)。キューのメタデータに使用されます。

シンセ
4.4.1
- (NSString* const) kGCKMetadataKeySectionStartAbsoluteTime

Double キー: セクション絶対開始時間。

セクション開始の絶対時間(エポック秒単位)。キューのメタデータに使用されます。

シンセ
4.4.1
- (NSString* const) kGCKMetadataKeySectionStartTimeInContainer

Double キー: コンテナでのセクションの開始時間。

コンテナ全体におけるセクション開始時間のオフセット。キューのメタデータに使用されます。

シンセ
4.4.1
- (NSString* const) kGCKMetadataKeyQueueItemID

Double キー: キューアイテム ID

セクション開始時間を含むキュー項目の ID。キューのメタデータに使用されます。

シンセ
4.4.1

プロパティの詳細

- (GCKMediaMetadataType) metadataType
readnonatomicassign

メタデータのタイプ。