com.box.androidsdk.preview.fragments

Class BoxPreviewVideoFragment

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

com.box.androidsdk.preview.fragments.BoxPreviewVideoFragment

All Implemented Interfaces:

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

public class BoxPreviewVideoFragment
extends BoxPreviewMediaFragment
implements android.view.TextureView.SurfaceTextureListener, android.view.View.OnClickListener

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 static java.lang.String	OUT_IS_VIDEO_STARTED
static java.lang.String	TAG

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

mAudioCapabilities, mAudioReceiver, mMediaControlAnchorView, mPlayer, mPlayerPosition, mSurfaceView, 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
BoxPreviewVideoFragment()

Method Summary

Modifier and Type	Method and Description
protected boolean	canInitPlayer() Returns whether all the components required by the player are ready and available
protected RendererBuilder	getBuilder() Gets the builder that creates the appropriate rendering for the player
static com.box.androidsdk.content.requests.BoxRequestsFile.DownloadThumbnail	getCacheThumbnailRequest(PreviewController previewController, com.box.androidsdk.content.models.BoxFile boxFile)
protected com.box.androidsdk.content.models.BoxRepresentation	getDashRepresentation()
protected android.net.Uri	getMediaUri()
protected BoxApiPreview.Extensions	getPreviewExtension() Gets the extension that will be used with the preview endpoint
protected void	hideError()
protected void	initPlayer() Initializes the player and notifies the activity that the fragment is ready
void	loadContent(BoxExecutor executor, java.util.Collection<java.util.concurrent.FutureTask> tasks, PreviewStorage storage)
protected void	onBoxRequestError(com.box.androidsdk.content.requests.BoxResponse response)
protected void	onBoxRequestSuccess(com.box.androidsdk.content.requests.BoxResponse response)
void	onClick(android.view.View v)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroyView()
void	onInternetConnectionChanged(boolean connected) Entry public static final String METADATA_DOCUMENT_TAG = "doc"; point to handle a lost or found internet connection at the fragment level.
void	onSaveInstanceState(android.os.Bundle outState)
void	onSurfaceTextureAvailable(android.graphics.SurfaceTexture surfaceTexture, int w, int h)
boolean	onSurfaceTextureDestroyed(android.graphics.SurfaceTexture surfaceTexture)
void	onSurfaceTextureSizeChanged(android.graphics.SurfaceTexture surfaceTexture, int h, int w)
void	onSurfaceTextureUpdated(android.graphics.SurfaceTexture surfaceTexture)
void	onVideoSizeChanged(int width, int height, float pixelWidthAspectRatio)
protected void	prepareMedia() Ensures the media is present and ready before loading it into the player
void	releasePlayer()
protected void	restartDownload() Logic to handle a restarted download, such as resetting requests, adding progress bars, and removing default views.
protected void	showUnavailable(java.lang.String message) Logic to handle unavailable previews, such as removing progress bars and showing default views.
protected boolean	tryContentUriStream() Attempts to play a video file through the download content endpoint

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

checkTasksBeforeExecute, getMediaControls, notifyFragmentLoaded, onAudioCapabilitiesChanged, onDestroy, onErrorOccurred, onPause, onResume, onTaskCompleted, setPreviewController, surfaceChanged, surfaceCreated, surfaceDestroyed, updateLoadingStatus

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

getProgressBar, getVisibleViews, hideProgress, initDefaultViews, isContainerVisible, onActivityCreated, onCreate, onStart, restoreStatus, setProgress, showProgress

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

cancelLoadContent, checkTasksBeforeExecute, createInstance, execute, getBoxFile, getBoxSession, getIntentFilter, getPosition, getPreviewController, handleMessage, isContentLoading, loadContent, notifyFragmentUnloaded, onDetach, 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

TAG

public static final java.lang.String TAG

OUT_IS_VIDEO_STARTED

protected static final java.lang.String OUT_IS_VIDEO_STARTED

See Also:

Constant Field Values

Constructor Detail

BoxPreviewVideoFragment

public BoxPreviewVideoFragment()

Method Detail

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Overrides:

onSaveInstanceState in class BoxPreviewMediaFragment

onInternetConnectionChanged

public void onInternetConnectionChanged(boolean connected)

Description copied from class: BoxPreviewFragment

Entry public static final String METADATA_DOCUMENT_TAG = "doc"; point to handle a lost or found internet connection at the fragment level.

Overrides:

onInternetConnectionChanged in class BoxPreviewFragment

Parameters:

connected - whether or not there is a valid internet connection

onCreateView

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

Overrides:

onCreateView in class BoxPreviewMediaFragment

onVideoSizeChanged

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

Specified by:

onVideoSizeChanged in interface BoxPlayer.Listener

Overrides:

onVideoSizeChanged in class BoxPreviewMediaFragment

restartDownload

protected void restartDownload()

Description copied from class: BoxPreviewFragment

Logic to handle a restarted download, such as resetting requests, adding progress bars, and removing default views.

Overrides:

restartDownload in class BoxPreviewDefaultFragment

showUnavailable

protected void showUnavailable(java.lang.String message)

Description copied from class: BoxPreviewFragment

Logic to handle unavailable previews, such as removing progress bars and showing default views.

Overrides:

showUnavailable in class BoxPreviewDefaultFragment

Parameters:

message - message to show when handling this error case.

hideError

protected void hideError()

Overrides:

hideError in class BoxPreviewDefaultFragment

getDashRepresentation

protected com.box.androidsdk.content.models.BoxRepresentation getDashRepresentation()

getBuilder

protected RendererBuilder getBuilder()

Description copied from class: BoxPreviewMediaFragment

Gets the builder that creates the appropriate rendering for the player

Specified by:

getBuilder in class BoxPreviewMediaFragment

Returns:

The builder to initialize the player with

getMediaUri

protected android.net.Uri getMediaUri()

Overrides:

getMediaUri in class BoxPreviewMediaFragment

getPreviewExtension

protected BoxApiPreview.Extensions getPreviewExtension()

Description copied from class: BoxPreviewMediaFragment

Gets the extension that will be used with the preview endpoint

Specified by:

getPreviewExtension in class BoxPreviewMediaFragment

Returns:

The extension for the preview

prepareMedia

protected void prepareMedia()

Ensures the media is present and ready before loading it into the player

onBoxRequestSuccess

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

Overrides:

onBoxRequestSuccess in class BoxPreviewMediaFragment

onBoxRequestError

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

Overrides:

onBoxRequestError in class BoxPreviewMediaFragment

loadContent

public void loadContent(BoxExecutor executor,
                        java.util.Collection<java.util.concurrent.FutureTask> tasks,
                        PreviewStorage storage)

Overrides:

loadContent in class BoxPreviewDefaultFragment

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class BoxPreviewMediaFragment

getCacheThumbnailRequest

public static com.box.androidsdk.content.requests.BoxRequestsFile.DownloadThumbnail getCacheThumbnailRequest(PreviewController previewController,
                                                                                                             com.box.androidsdk.content.models.BoxFile boxFile)

releasePlayer

public void releasePlayer()

Overrides:

releasePlayer in class BoxPreviewMediaFragment

canInitPlayer

protected boolean canInitPlayer()

Description copied from class: BoxPreviewMediaFragment

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

Overrides:

canInitPlayer in class BoxPreviewMediaFragment

Returns:

Whether initPlayer can be called

initPlayer

protected void initPlayer()

Description copied from class: BoxPreviewMediaFragment

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

Overrides:

initPlayer in class BoxPreviewMediaFragment

onSurfaceTextureAvailable

public void onSurfaceTextureAvailable(android.graphics.SurfaceTexture surfaceTexture,
                                      int w,
                                      int h)

Specified by:

onSurfaceTextureAvailable in interface android.view.TextureView.SurfaceTextureListener

onSurfaceTextureSizeChanged

public void onSurfaceTextureSizeChanged(android.graphics.SurfaceTexture surfaceTexture,
                                        int h,
                                        int w)

Specified by:

onSurfaceTextureSizeChanged in interface android.view.TextureView.SurfaceTextureListener

onSurfaceTextureDestroyed

public boolean onSurfaceTextureDestroyed(android.graphics.SurfaceTexture surfaceTexture)

Specified by:

onSurfaceTextureDestroyed in interface android.view.TextureView.SurfaceTextureListener

onSurfaceTextureUpdated

public void onSurfaceTextureUpdated(android.graphics.SurfaceTexture surfaceTexture)

Specified by:

onSurfaceTextureUpdated in interface android.view.TextureView.SurfaceTextureListener

onClick

public void onClick(android.view.View v)

Specified by:

onClick in interface android.view.View.OnClickListener

tryContentUriStream

protected boolean tryContentUriStream()

Attempts to play a video file through the download content endpoint

Returns:

whether or not the file was able to be played through the content endpoint