DrmSessionEventListener


@UnstableApi
public interface DrmSessionEventListener

Known direct subclasses
AnalyticsCollector

Interface for data collectors that forward analytics events to AnalyticsListeners.

ServerSideAdInsertionMediaSource

A MediaSource for server-side inserted ad breaks.

Known indirect subclasses
DefaultAnalyticsCollector

Data collector that forwards analytics events to AnalyticsListeners.


Listener of DrmSessionManager events.

Summary

Nested types

Dispatches events to DrmSessionEventListeners.

Public methods

default void
onDrmKeysLoaded(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time keys are loaded.

default void
onDrmKeysRemoved(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time offline keys are removed.

default void
onDrmKeysRestored(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time offline keys are restored.

default void
onDrmSessionAcquired(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

This method is deprecated.

Implement onDrmSessionAcquired instead.

default void
onDrmSessionAcquired(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    @DrmSession.State int state
)

Called each time a drm session is acquired.

default void
onDrmSessionManagerError(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    Exception error
)

Called when a drm error occurs.

default void
onDrmSessionReleased(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time a drm session is released.

Public methods

onDrmKeysLoaded

default void onDrmKeysLoaded(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time keys are loaded.

Parameters
int windowIndex

The window index in the timeline this media period belongs to.

@Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId associated with the drm session.

onDrmKeysRemoved

default void onDrmKeysRemoved(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time offline keys are removed.

Parameters
int windowIndex

The window index in the timeline this media period belongs to.

@Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId associated with the drm session.

onDrmKeysRestored

default void onDrmKeysRestored(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time offline keys are restored.

Parameters
int windowIndex

The window index in the timeline this media period belongs to.

@Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId associated with the drm session.

onDrmSessionAcquired

default void onDrmSessionAcquired(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

onDrmSessionAcquired

default void onDrmSessionAcquired(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    @DrmSession.State int state
)

Called each time a drm session is acquired.

Parameters
int windowIndex

The window index in the timeline this media period belongs to.

@Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId associated with the drm session.

@DrmSession.State int state

The DrmSession.State of the session when the acquisition completed.

onDrmSessionManagerError

default void onDrmSessionManagerError(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    Exception error
)

Called when a drm error occurs.

This method being called does not indicate that playback has failed, or that it will fail. The player may be able to recover from the error and continue. Hence applications should not implement this method to display a user visible error or initiate an application level retry (onPlayerError is the appropriate place to implement such behavior). This method is called to provide the application with an opportunity to log the error if it wishes to do so.

Parameters
int windowIndex

The window index in the timeline this media period belongs to.

@Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId associated with the drm session.

Exception error

The corresponding exception.

onDrmSessionReleased

default void onDrmSessionReleased(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Called each time a drm session is released.

Parameters
int windowIndex

The window index in the timeline this media period belongs to.

@Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId associated with the drm session.