com.box.androidsdk.preview.fragments

Class BoxPreviewMediaFragment

java.lang.Object

android.support.v4.app.Fragment

com.box.androidsdk.preview.fragments.BoxPreviewFragment

com.box.androidsdk.preview.fragments.BoxPreviewDefaultFragment

com.box.androidsdk.preview.fragments.BoxPreviewMediaFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.SurfaceHolder.Callback, android.view.View.OnCreateContextMenuListener, BoxExecutor, BoxPlayer.Listener, com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener

Direct Known Subclasses:

BoxPreviewAudioFragment, BoxPreviewVideoFragment

public abstract class BoxPreviewMediaFragment
extends BoxPreviewDefaultFragment
implements android.view.SurfaceHolder.Callback, com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener, BoxPlayer.Listener

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.preview.fragments.BoxPreviewFragment

BoxPreviewFragment.BoxPreviewController, BoxPreviewFragment.Listener

Nested classes/interfaces inherited from class android.support.v4.app.Fragment

android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.android.exoplayer.audio.AudioCapabilities	mAudioCapabilities
protected com.google.android.exoplayer.audio.AudioCapabilitiesReceiver	mAudioReceiver
protected android.view.ViewGroup	mMediaControlAnchorView
protected BoxMediaControls	mPlayer
protected int	mPlayerPosition
protected android.view.View	mSurfaceView
protected static java.lang.String	OUT_PLAYER_POSITION

Fields inherited from class com.box.androidsdk.preview.fragments.BoxPreviewDefaultFragment

mIsErrorShowing, mReportsTransferBytes

Fields inherited from class com.box.androidsdk.preview.fragments.BoxPreviewFragment

EXTRA_BOX_ITEM, EXTRA_POSITION, EXTRA_PREVIEW_LOADED, EXTRA_THUMBNAIL_LOADED, mController, mPosition, mPreviewLoaded, mReceiver, mThumbnailLoaded

Constructor Summary

Constructors

Constructor and Description
BoxPreviewMediaFragment()

Method Summary

Modifier and Type	Method and Description
protected boolean	canInitPlayer() Returns whether all the components required by the player are ready and available
<E extends com.box.androidsdk.content.models.BoxObject> com.box.androidsdk.content.requests.BoxResponse<E>	checkTasksBeforeExecute(InspectableBoxFutureTask request) Checks if the request has already been added to the task queue.
protected abstract RendererBuilder	getBuilder() Gets the builder that creates the appropriate rendering for the player
BoxMediaControls	getMediaControls()
protected android.net.Uri	getMediaUri()
protected abstract BoxApiPreview.Extensions	getPreviewExtension() Gets the extension that will be used with the preview endpoint
protected void	initPlayer() Initializes the player and notifies the activity that the fragment is ready
protected void	notifyFragmentLoaded() Notifies listeners that all necessary components required by the preview fragment are loaded and ready
void	onAudioCapabilitiesChanged(com.google.android.exoplayer.audio.AudioCapabilities audioCapabilities)
protected void	onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)
protected void	onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroy()
void	onDestroyView()
void	onErrorOccurred(java.lang.Exception ex)
void	onPause()
void	onResume()
void	onSaveInstanceState(android.os.Bundle outState)
void	onTaskCompleted(java.util.concurrent.FutureTask task, java.util.Collection<java.util.concurrent.FutureTask> tasks, PreviewStorage storage)
void	onVideoSizeChanged(int width, int height, float pixelWidthAspectRatio)
void	releasePlayer()
void	setPreviewController(BoxPreviewFragment.BoxPreviewController controller)
void	surfaceChanged(android.view.SurfaceHolder surfaceHolder, int i, int i1, int i2)
void	surfaceCreated(android.view.SurfaceHolder surfaceHolder)
void	surfaceDestroyed(android.view.SurfaceHolder surfaceHolder)
protected void	updateLoadingStatus()

Methods inherited from class com.box.androidsdk.preview.fragments.BoxPreviewDefaultFragment

getProgressBar, getVisibleViews, hideError, hideProgress, initDefaultViews, isContainerVisible, loadContent, onActivityCreated, onCreate, onStart, restartDownload, restoreStatus, setProgress, showProgress, showUnavailable

Methods inherited from class com.box.androidsdk.preview.fragments.BoxPreviewFragment

cancelLoadContent, checkTasksBeforeExecute, createInstance, execute, getBoxFile, getBoxSession, getIntentFilter, getPosition, getPreviewController, handleMessage, isContentLoading, loadContent, notifyFragmentUnloaded, onDetach, onInternetConnectionChanged, setUserVisibleHint, showNetworkUnavailable

Methods inherited from class android.support.v4.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isVisible, onActivityResult, onAttach, onAttach, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPrepareOptionsMenu, onRequestPermissionsResult, onStop, onViewCreated, onViewStateRestored, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OUT_PLAYER_POSITION

protected static final java.lang.String OUT_PLAYER_POSITION

See Also:

Constant Field Values

mPlayer

protected BoxMediaControls mPlayer

mMediaControlAnchorView

protected android.view.ViewGroup mMediaControlAnchorView

mSurfaceView

protected android.view.View mSurfaceView

mPlayerPosition

protected int mPlayerPosition

mAudioReceiver

protected com.google.android.exoplayer.audio.AudioCapabilitiesReceiver mAudioReceiver

mAudioCapabilities

protected com.google.android.exoplayer.audio.AudioCapabilities mAudioCapabilities

Constructor Detail

BoxPreviewMediaFragment

public BoxPreviewMediaFragment()

Method Detail

onCreateView

@Nullable
public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                                android.view.ViewGroup container,
                                                android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class BoxPreviewDefaultFragment

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Overrides:

onSaveInstanceState in class BoxPreviewDefaultFragment

setPreviewController

public void setPreviewController(BoxPreviewFragment.BoxPreviewController controller)

Overrides:

setPreviewController in class BoxPreviewFragment

onBoxRequestSuccess

protected void onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)

Overrides:

onBoxRequestSuccess in class BoxPreviewDefaultFragment

onBoxRequestError

protected void onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)

Overrides:

onBoxRequestError in class BoxPreviewDefaultFragment

onTaskCompleted

public void onTaskCompleted(java.util.concurrent.FutureTask task,
                            java.util.Collection<java.util.concurrent.FutureTask> tasks,
                            PreviewStorage storage)

Overrides:

onTaskCompleted in class BoxPreviewFragment

onResume

public void onResume()

Overrides:

onResume in class BoxPreviewFragment

onPause

public void onPause()

Overrides:

onPause in class BoxPreviewFragment

onDestroy

public void onDestroy()

Overrides:

onDestroy in class BoxPreviewFragment

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class android.support.v4.app.Fragment

onAudioCapabilitiesChanged

public void onAudioCapabilitiesChanged(com.google.android.exoplayer.audio.AudioCapabilities audioCapabilities)

Specified by:

onAudioCapabilitiesChanged in interface com.google.android.exoplayer.audio.AudioCapabilitiesReceiver.Listener

surfaceCreated

public void surfaceCreated(android.view.SurfaceHolder surfaceHolder)

Specified by:

surfaceCreated in interface android.view.SurfaceHolder.Callback

surfaceChanged

public void surfaceChanged(android.view.SurfaceHolder surfaceHolder,
                           int i,
                           int i1,
                           int i2)

Specified by:

surfaceChanged in interface android.view.SurfaceHolder.Callback

surfaceDestroyed

public void surfaceDestroyed(android.view.SurfaceHolder surfaceHolder)

Specified by:

surfaceDestroyed in interface android.view.SurfaceHolder.Callback

onVideoSizeChanged

public void onVideoSizeChanged(int width,
                               int height,
                               float pixelWidthAspectRatio)

Specified by:

onVideoSizeChanged in interface BoxPlayer.Listener

onErrorOccurred

public void onErrorOccurred(java.lang.Exception ex)

Specified by:

onErrorOccurred in interface BoxPlayer.Listener

notifyFragmentLoaded

protected void notifyFragmentLoaded()

Description copied from class: BoxPreviewFragment

Notifies listeners that all necessary components required by the preview fragment are loaded and ready

Overrides:

notifyFragmentLoaded in class BoxPreviewFragment

getMediaUri

protected android.net.Uri getMediaUri()

getBuilder

protected abstract RendererBuilder getBuilder()

Gets the builder that creates the appropriate rendering for the player

Returns:

The builder to initialize the player with

getPreviewExtension

protected abstract BoxApiPreview.Extensions getPreviewExtension()

Gets the extension that will be used with the preview endpoint

Returns:

The extension for the preview

checkTasksBeforeExecute

public <E extends com.box.androidsdk.content.models.BoxObject> com.box.androidsdk.content.requests.BoxResponse<E> checkTasksBeforeExecute(InspectableBoxFutureTask request)

Description copied from class: BoxPreviewFragment

Checks if the request has already been added to the task queue. If the request is done it will attempt to return the response. If the request is not in the task queue or was not successful, the request will be executed again. This will compare the request class name as well as the tag to see if the request has already been added.

Overrides:

checkTasksBeforeExecute in class BoxPreviewFragment

Type Parameters:

E - return type for the request that extends from BoxObject

Parameters:

request - the inspectable request to try executing

Returns:

The completed response for the request only if it was successful

updateLoadingStatus

protected void updateLoadingStatus()

canInitPlayer

protected boolean canInitPlayer()

Returns whether all the components required by the player are ready and available

Returns:

Whether initPlayer can be called

initPlayer

protected void initPlayer()

Initializes the player and notifies the activity that the fragment is ready

releasePlayer

public void releasePlayer()

getMediaControls

public BoxMediaControls getMediaControls()