com.docomostar.media.avcontent
クラス PlayableInfo

Object
  com.docomostar.media.avcontent.PlayableInfo

public class PlayableInfo
extends Object

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

再生制限情報を定義します。

再生制限情報は、そのコンテンツが音楽プレイヤで再生可能かどうかを表します。 再生制限情報として回数による再生制限、再生期限制限、 再生期間制限、UIM制限、 コンテンツ更新の猶予期限があります。

isPlayable() を呼び出すことで、 コンテンツに設定されている再生制限情報を総合的に判断した結果として、 コンテンツの再生が可能かどうかを取得することができます。

なお、再生制限情報として回数による再生制限が存在するコンテンツは、 音楽プレイヤからは再生可能な残り回数に関わらず再生できない点に注意してください。 (isPlayable()において、常に falseが返ります)

導入されたバージョン:

Star-1.5

関連項目:

Content

フィールドの概要

static int	RESTRICT_TYPE_COUNT 回数による再生制限があることを表します(=0x01)。
static int	RESTRICT_TYPE_PERIOD 期限による再生制限があることを表します(=0x04)。
static int	RESTRICT_TYPE_SPAN 期間による再生制限があることを表します(=0x02)。
static int	UIM_RESTRICT_DETACHED UIM が挿入されていないことによる制限がある状態を表します (=1)。
static int	UIM_RESTRICT_DIFFERENT 異なる UIM が挿入されていることによる制限がある状態を表します (=2)。
static int	UIM_RESTRICT_FREE UIM による制限がない状態を表します (=0)。

メソッドの概要

java.util.Date	getGracePeriod() コンテンツ更新の猶予期限を取得します。
java.util.Date	getPlayablePeriod() 再生可能な期限を取得します。
java.util.Date	getPlayableSpanEnd() 再生可能な期間の終了日時を取得します。
java.util.Date	getPlayableSpanStart() 再生可能な期間の開始日時を取得します。
int	getRestrictType() 再生制限種別を取得します。
int	getUIMRestrict() UIM による制限情報を取得します。
boolean	isPlayable() 総合的に判断して再生可能かどうかを取得します。

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

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

フィールドの詳細

RESTRICT_TYPE_COUNT

public static final int RESTRICT_TYPE_COUNT

回数による再生制限があることを表します(=0x01)。

関連項目:

getRestrictType(), 定数フィールド値

RESTRICT_TYPE_SPAN

public static final int RESTRICT_TYPE_SPAN

期間による再生制限があることを表します(=0x02)。

関連項目:

getRestrictType(), 定数フィールド値

RESTRICT_TYPE_PERIOD

public static final int RESTRICT_TYPE_PERIOD

期限による再生制限があることを表します(=0x04)。

関連項目:

getRestrictType(), 定数フィールド値

UIM_RESTRICT_FREE

public static final int UIM_RESTRICT_FREE

UIM による制限がない状態を表します (=0)。

関連項目:

getUIMRestrict(), 定数フィールド値

UIM_RESTRICT_DETACHED

public static final int UIM_RESTRICT_DETACHED

UIM が挿入されていないことによる制限がある状態を表します (=1)。

関連項目:

getUIMRestrict(), 定数フィールド値

UIM_RESTRICT_DIFFERENT

public static final int UIM_RESTRICT_DIFFERENT

異なる UIM が挿入されていることによる制限がある状態を表します (=2)。

関連項目:

getUIMRestrict(), 定数フィールド値

メソッドの詳細

getRestrictType

public int getRestrictType()

再生制限種別を取得します。

RESTRICT_TYPE_COUNT, RESTRICT_TYPE_SPAN, RESTRICT_TYPE_PERIOD の論理和が返されます。
いずれの再生制限種別にも該当しない場合は 0 を返します。

戻り値:

再生制限のかかっている情報の論理和を返します。

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

getPlayableSpanStart

public java.util.Date getPlayableSpanStart()

再生可能な期間の開始日時を取得します。

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

戻り値:

再生可能な期間の開始日時を返します。

関連項目:

getPlayableSpanEnd()

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

getPlayableSpanEnd

public java.util.Date getPlayableSpanEnd()

再生可能な期間の終了日時を取得します。

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

戻り値:

再生可能な期間の終了日時を返します。

関連項目:

getPlayableSpanStart()

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

getPlayablePeriod

public java.util.Date getPlayablePeriod()

再生可能な期限を取得します。

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

戻り値:

再生可能な期限を返します。

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

getGracePeriod

public java.util.Date getGracePeriod()

コンテンツ更新の猶予期限を取得します。
コンテンツ更新の猶予期限が設定されていると、再生期限が過ぎている場合でも、 猶予期限の日まではコンテンツを再生可能です。

猶予期限が設定されていない場合は null を返します。

戻り値:

猶予期限を返します。

関連項目:

getPlayablePeriod()

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

getUIMRestrict

public int getUIMRestrict()

UIM による制限情報を取得します。

UIM_RESTRICT_FREE、UIM_RESTRICT_DETACHED、 UIM_RESTRICT_DIFFERENT のいずれかが返ります。

戻り値:

UIM 制限情報を返します。

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

isPlayable

public boolean isPlayable()

総合的に判断して再生可能かどうかを取得します。

下記のいずれかの場合に、再生可能ではないと判断されます。

• 回数による再生制限が存在する場合
• コンテンツ更新の猶予期限が存在せず、再生可能な期限が過ぎている場合
• コンテンツ更新の猶予期限、及び再生可能な期限の両方が期限を過ぎている場合
• 再生可能な期間ではない場合
• UIMによる制限を受ける場合

コンテンツが再生可能かどうかは、本メソッドが呼ばれるたびにメソッド呼び出し時点の現在時刻、及び UIM 制限をもとに判断されます。

戻り値:

総合的に判断して、コンテンツが再生可能な場合は true を、 そうでない場合は false を返します。

例外:

MediaException -
(ILLEGAL_STATE)
本インスタンスを取得した後に、括り付けられているコンテンツが unload() されていた場合に発生します。

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