com.docomostar.media.avcontent
クラス MusicContent

Object
  com.docomostar.media.avcontent.ManagedData
      com.docomostar.media.avcontent.Content
          com.docomostar.media.avcontent.MusicContent

public class MusicContent
extends Content

[iアプリオプションAPI]

音楽コンテンツを定義します。

このオブジェクトで定義される以下の属性は詳細データとして扱われます。

• ジャケット画像
• 待ち受け用画像

上記以外の属性は基本データとして扱われます。 スーパークラスで定義されている属性の種別については、スーパークラスのクラス説明を参照してください。 属性の種別については ManagedData のクラス説明を参照してください。

unload() メソッドを呼び出すと、 この音楽コンテンツに添付されているジャケット画像、待ち受け用画像の Image も自動的に dispose() が行われます。 有効なオブジェクトが必要な場合は、再度 getJacketImage() 及び getStandbyImages() でオブジェクトを取得し直してください。

導入されたバージョン:

Star-1.5

フィールドの概要

static int	RINGTONE_TYPE_FREE 着信音設定種別の 1 つで、おこのみ着信音設定を表します(=2)。
static int	RINGTONE_TYPE_RECOMMENDED 着信音設定種別の 1 つで、オススメ着信音設定を表します(=1)。

クラス com.docomostar.media.avcontent.Content から継承されたフィールド

PERMISSION_ALL, PERMISSION_NONE, PERMISSION_PLATFORM, RINGTONE_TYPE_FULL, TYPE_FULLMUSIC, TYPE_FULLMUSIC_SUBSCRIPTION, TYPE_MP3, TYPE_SDAUDIO, TYPE_WMA

メソッドの概要

boolean	canSetRingtone(int type) 着信音設定の可否を取得します。
String	getAlbum() アルバムを取得します。
String	getAltUrl() 関連 URL 代替文字列を取得します。
String	getArtist() アーティストを取得します。
String	getComment() コメントを取得します。
String	getComposer() 作曲者を取得します。
String	getGenre() ジャンルを取得します。
Image	getJacketImage() ジャケット画像を取得します。
String	getLabel() レーベルを取得します。
String	getLyricist() 作詞者を取得します。
String	getRightsHolder() 権利者を取得します。
String	getRightsInfo() 権利情報を取得します。
String	getSellingAgency() 販売元を取得します。
Image[]	getStandbyImages() 全ての待ち受け用画像を配列として取得します。
int	getTotalTracks() 総トラック数を取得します。
int	getTrackNumber() トラック番号を取得します。
String	getUrl() 関連 URL を取得します。
int	getYear() 作成年を取得します。
boolean	hasExtractableJacketImage() 保存可能ジャケット画像の有無を取得します。
boolean	hasExtractableStandbyImage() 保存可能待ち受け用画像の有無を取得します。
void	unload() キャッシュされている属性を解放します。

クラス com.docomostar.media.avcontent.Content から継承されたメソッド

getAudioCodecInfo, getExportPermission, getFileName, getFileSizeOnMemory, getImportPermission, getOrigin, getPlayableInfo, getSavedDate, getTotalTime, getType, hasPlayableInfo, isFileRestricted

クラス com.docomostar.media.avcontent.ManagedData から継承されたメソッド

getTitleName

クラス Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

RINGTONE_TYPE_RECOMMENDED

public static final int RINGTONE_TYPE_RECOMMENDED

着信音設定種別の 1 つで、オススメ着信音設定を表します(=1)。

関連項目:

定数フィールド値

RINGTONE_TYPE_FREE

public static final int RINGTONE_TYPE_FREE

着信音設定種別の 1 つで、おこのみ着信音設定を表します(=2)。

関連項目:

定数フィールド値

メソッドの詳細

getArtist

public String getArtist()

アーティストを取得します。

値が設定されていない場合は、 null を返します。

戻り値:

アーティストを返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getAlbum

public String getAlbum()

アルバムを取得します。

値が設定されていない場合は、 null を返します。

戻り値:

アルバムを返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getGenre

public String getGenre()

ジャンルを取得します。

値が設定されていない場合は、 null を返します。

戻り値:

ジャンルを返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getTrackNumber

public int getTrackNumber()

トラック番号を取得します。

値が設定されていない場合は、 -1 を返します。

戻り値:

トラック番号を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getTotalTracks

public int getTotalTracks()

総トラック数を取得します。

値が設定されていない場合は、 -1 を返します。

戻り値:

総トラック数を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getYear

public int getYear()

作成年を取得します。

値が設定されていない場合は、 -1 を返します。

戻り値:

作成年を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getLyricist

public String getLyricist()

作詞者を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

作詞者を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getComposer

public String getComposer()

作曲者を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

作曲者を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getLabel

public String getLabel()

レーベルを取得します。

値が設定されていない場合は、 null を返します。

戻り値:

レーベルを返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getComment

public String getComment()

コメントを取得します。

値が設定されていない場合は、 null を返します。

戻り値:

コメントを返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getUrl

public String getUrl()

関連 URL を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

関連 URL を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getAltUrl

public String getAltUrl()

関連 URL 代替文字列を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

関連 URL 代替文字列を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getRightsHolder

public String getRightsHolder()

権利者を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

権利者を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getSellingAgency

public String getSellingAgency()

販売元を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

販売元を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getRightsInfo

public String getRightsInfo()

権利情報を取得します。

値が設定されていない場合は、 null を返します。

戻り値:

権利情報を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getJacketImage

public Image getJacketImage()

ジャケット画像を取得します。

このメソッドでは、コンテンツが保持するジャケット画像を取得することができます。 ジャケット画像が存在しない場合は、 null を返します。 画像データが不正などの理由で画像の取得ができない場合は例外 MediaException(UNDEFINED) が発生します。

このメソッドを呼び出した際に属性がキャッシュされていなければ、新しい Image オブジェクトを生成して返します。 属性がキャッシュ済みの場合、 Image オブジェクトをImage.dispose() しない限り、 このメソッドを複数回呼び出しても同一の有効な Image オブジェクトへの参照が返されます。 Image オブジェクトを dispose() してからこのメソッドを呼び出すと、新しく有効な Image オブジェクトが生成されて返されます。

本メソッドから取得した Image は「XString が描画された Image」と同等の扱いとなります。 すなわち、このメソッドで返される Image を描画したキャンバスや別のイメージからは、 画素データを読み出したり、描画内容を JPEG 形式等の形で取り出したりすることは許可されません。 重大なセキュリティ違反であるとして、アプリケーションは強制終了します。

戻り値:

ジャケット画像を返します。

例外:

MediaException -
(NO_RESOURCES)
リソース不足のため取得に失敗した場合に発生します。

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

getStandbyImages

public Image[] getStandbyImages()

全ての待ち受け用画像を配列として取得します。

このメソッドでは、コンテンツが保持する待ち受け用画像を取得することができます。 画像が 1 つも存在しない場合は null を返します。

画像データが不正などの理由で画像が取得できない場合は、以下のように振舞います。

コンテンツ内の全ての画像の取得ができない場合

例外 MediaException(UNDEFINED) が発生します。

コンテンツ内の画像のうち、一部のみ取得ができない場合

取得できない画像のインデックスの値に null が代入された Image の配列が返ります。
※例 コンテンツ内に存在する画像が 2 枚で、そのうち 1 枚目の画像データが不正な場合は、 第 0 要素に null が代入された配列長が 2 の配列が返されます。

このメソッドを呼び出した際に返される配列は、 Image オブジェクトを参照するために内部で保持している配列のコピーになります。 ただし、参照される各 Image オブジェクトはコピーされません。

Image オブジェクトを dispose() してからこのメソッドを呼び出すと、新しく有効な Image オブジェクトが生成されて内部で保持している配列に格納されます。

本メソッドから取得した Image は「XString が描画された Image」と同等の扱いとなります。 すなわち、このメソッドで返される Image を描画したキャンバスや別のイメージからは、 画素データを読み出したり、描画内容を JPEG 形式等の形で取り出したりすることは許可されません。 重大なセキュリティ違反であるとして、アプリケーションは強制終了します。

戻り値:

待ち受け用画像の一覧を返します。

例外:

MediaException -
(NO_RESOURCES)
リソース不足のため取得に失敗した場合に発生します。

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

hasExtractableJacketImage

public boolean hasExtractableJacketImage()

保存可能ジャケット画像の有無を取得します。

このメソッドでは、コンテンツに保存可能なジャケット画像があるかどうかを取得できます。 保存可能なジャケット画像がある場合は true、 ない場合は false を返します。

戻り値:

保存可能ジャケット画像の有無を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

hasExtractableStandbyImage

public boolean hasExtractableStandbyImage()

保存可能待ち受け用画像の有無を取得します。

このメソッドでは、コンテンツに保存可能な待ち受け用画像があるかどうかを取得できます。 保存可能な待ち受け用画像がある場合は true、 ない場合は false を返します。

戻り値:

保存可能待ち受け用画像の有無を返します。

例外:

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

canSetRingtone

public boolean canSetRingtone(int type)

着信音設定の可否を取得します。

引数 type で指定した種別の着信音設定可否を取得できます。 引数 type には Content.RINGTONE_TYPE_FULL、RINGTONE_TYPE_RECOMMENDED、RINGTONE_TYPE_FREE が指定可能です。 それ以外の値を指定した場合、例外が発生します。

属性に値が設定されていない場合は、 false を返します。

オーバーライド:

クラス Content 内の canSetRingtone

パラメータ:

type - 着信音設定の種別を指定します。

戻り値:

着信音設定の可否を返します。着信音に設定できる場合は true、設定できない場合は false を返します。

関連項目:

Content.RINGTONE_TYPE_FULL, RINGTONE_TYPE_RECOMMENDED, RINGTONE_TYPE_FREE

例外:

IllegalArgumentException -
引数 type に不正な値が指定された場合に発生します。

MediaException -
(UNDEFINED)
何らかの理由で取得に失敗した場合に発生します。

unload

public void unload()

キャッシュされている属性を解放します。 解放の対象となる属性は、このクラスおよび Content クラスで定義されている属性です。

上記以外のこのメソッドの詳細は、Content のクラス説明を参照して下さい。

オーバーライド:

クラス Content 内の unload