com.pili.pldroid.streaming

Class CameraStreamingManager

java.lang.Object

com.pili.pldroid.streaming.CameraStreamingManager

public final class CameraStreamingManager
extends java.lang.Object

The CameraStreamingManager class is core of Streaming.

It is used to set Camera setting, Streaming profile, Layout, View, Listener and Callback. This class is a manager of Streaming, including Audio Streaming, Video Streaming, AV Streaming, which manages the whole Streaming logical.

The calling sequence of the class should be:

1. Construct CameraStreamingManager(Context, com.pili.pldroid.streaming.widget.AspectFrameLayout, GLSurfaceView, com.pili.pldroid.streaming.CameraStreamingManager.EncodingType)
2. prepare(com.pili.pldroid.streaming.StreamingProfile)
3. resume()
4. startStreaming()/stopStreaming()/switchCamera()/captureFrame(int, int, com.pili.pldroid.streaming.FrameCapturedCallback)/etc.
5. pause()
6. destroy()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CameraStreamingManager.EncodingType EncodingType that can be used.
static class	CameraStreamingManager.STATE STATE that notified by CameraStreamingManager.
static interface	CameraStreamingManager.StreamingSessionListener Callback interface for some particular Streaming incidents.
static interface	CameraStreamingManager.StreamingStateListener Callback interface for Streaming State.

Constructor Summary

Constructors

Constructor and Description
CameraStreamingManager(Context ctx) Standard CameraStreamingManager constructor.
CameraStreamingManager(Context ctx, AspectFrameLayout layout, GLSurfaceView view) Constructor for AV streaming.
CameraStreamingManager(Context ctx, AspectFrameLayout layout, GLSurfaceView view, CameraStreamingManager.EncodingType encodingType) Constructor for AV streaming or Video Streaming.
CameraStreamingManager(Context ctx, CameraStreamingManager.EncodingType type) Constructor for Audio Streaming, without setting View and Layout.

Method Summary

Modifier and Type	Method and Description
void	captureFrame(int width, int height, FrameCapturedCallback callback) Send a capture frame request and FrameCapturedCallback.onFrameCaptured(Bitmap) will be invoked after finishing capturing.
void	destroy() Destroy some non-critical resources.
void	doPauseStreaming()
void	doResumeStreaming()
void	doSingleTapUp(int x, int y) Do single tap to trigger the Camera#autoFocus(Camera.AutoFocusCallback).
void	frameAvailable(int textureId, SurfaceTexture texture, boolean needCustomTextTarget)
int	getMaxZoom() Gets the maximum zoom value allowed for preview and streaming.
int	getZoom() Gets current zoom value.
boolean	isZoomSupported() Returns true if zoom is supported.
void	mute(boolean enable) Enable or disable the mute feature.
void	muxerStatusUpdate(EncodingConfig.MUXER_STATE muxerState)
void	muxerStatusUpdate(EncodingConfig.MUXER_STATE muxerState, java.lang.Object extra)
void	networkBlocking()
void	noNV21PrvFormat()
void	notifyActivityOrientationChanged() Notify Orientation of Activity Changed.
void	notifyFirstEncodingAudioFrame(boolean isMicrophoneOpenFailed)
void	notifyFirstEncodingFrame()
void	notifyProfileChanged(StreamingProfile profile) Deprecated. instead by setStreamingProfile(com.pili.pldroid.streaming.StreamingProfile)
void	notifyPrvSizeChanged(Camera.Size size)
void	onDestroy() Deprecated. replaced by destroy()
void	onEncoderExitDone()
void	onPause() Deprecated. replaced by pause()
boolean	onPrepare(CameraStreamingSetting setting, StreamingProfile profile) Deprecated. replaced by prepare(CameraStreamingSetting, StreamingProfile)
boolean	onPrepare(StreamingProfile profile) Deprecated. replaced by prepare(StreamingProfile)
void	onPreviewFrame(byte[] bytes, Camera camera, long ts)
void	onPreviewFrame(byte[] bytes, long ts)
Camera.Size	onPreviewSizeSelected(java.util.List<Camera.Size> list)
boolean	onResume() Deprecated. replaced by resume()
void	openCameraDeviceFailed(int camId)
void	pause() Pause the CameraStreamingManager.
boolean	prepare(CameraStreamingSetting camSetting, MicrophoneStreamingSetting microphoneSetting, StreamingProfile profile)
boolean	prepare(CameraStreamingSetting camSetting, MicrophoneStreamingSetting microphoneSetting, WatermarkSetting wmSetting, StreamingProfile profile)
boolean	prepare(CameraStreamingSetting setting, StreamingProfile profile) Prepare the CameraStreamingSetting and StreamingProfile to CameraStreamingManager.
boolean	prepare(StreamingProfile profile) Prepare the StreamingProfile to CameraStreamingManager, only for pure Audio Streaming.
boolean	resume() Resume the CameraStreamingManager.
void	setFocusAreaIndicator(ViewGroup indicatorLayout, View indicator) Sets the indicator for focusing UI.
void	setNativeLoggingEnabled(boolean enabled) Enable or disable the native logs.
void	setStreamingPreviewCallback(StreamingPreviewCallback callback) Registers a callback to be invoked when a Preview Frame arrives.
void	setStreamingProfile(StreamingProfile profile) update the StreamingProfile which associated with CameraStreamingManager.
void	setStreamingSessionListener(CameraStreamingManager.StreamingSessionListener listener) Registers a listener to be notified when the CameraStreamingManager's Session is changed.
void	setStreamingStateListener(CameraStreamingManager.StreamingStateListener listener) Registers a listener to be notified when the CameraStreamingManager's State is updated.
void	setStreamStatusCallback(StreamStatusCallback callback) Registers a callback to notify StreamingProfile.StreamStatus, including audioFps, videoFps and totalAVBitrate.
void	setSurfaceTextureCallback(SurfaceTextureCallback callback) Registers a callback to handle(filter) the display source to be rendered.
void	setVideoFilterType(com.pili.pldroid.streaming.CameraStreamingSetting.VIDEO_FILTER_TYPE filterType)
void	setZoomValue(int value) Sets current zoom value.
boolean	startStreaming() Start Streaming.
boolean	stopStreaming() Stop Streaming.
boolean	switchCamera() Switch to another camera.
boolean	turnLightOff() Turn flashlight off.
boolean	turnLightOn() Turn flashlight on.
void	updateEncodingType(CameraStreamingManager.EncodingType newType) update the EncodingType.
void	updateFaceBeautySetting(com.pili.pldroid.streaming.CameraStreamingSetting.FaceBeautySetting fbSetting)

Methods inherited from class java.lang.Object

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

Constructor Detail

CameraStreamingManager

public CameraStreamingManager(Context ctx)

Standard CameraStreamingManager constructor.

CameraStreamingManager.EncodingType.HW_AUDIO_CODEC as the default CameraStreamingManager.EncodingType.

Parameters:

ctx - the Context of the App.

CameraStreamingManager

public CameraStreamingManager(Context ctx,
                              CameraStreamingManager.EncodingType type)

Constructor for Audio Streaming, without setting View and Layout.

Ony CameraStreamingManager.EncodingType.SW_AUDIO_CODEC and CameraStreamingManager.EncodingType.HW_AUDIO_CODEC are accept in this constructor, otherwise, IllegalStateException will be thrown.

Parameters:

ctx - the Context of the App.

type - the CameraStreamingManager.EncodingType of the CameraStreamingManager.

CameraStreamingManager

public CameraStreamingManager(Context ctx,
                              AspectFrameLayout layout,
                              GLSurfaceView view)

Constructor for AV streaming.

CameraStreamingManager.EncodingType.HW_VIDEO_WITH_HW_AUDIO_CODEC as the default CameraStreamingManager.EncodingType.

Parameters:

ctx - the Context of the App.

layout - the Layout of the rendering view

view - the View for displaying OpenGL rendering.

CameraStreamingManager

public CameraStreamingManager(Context ctx,
                              AspectFrameLayout layout,
                              GLSurfaceView view,
                              CameraStreamingManager.EncodingType encodingType)

Constructor for AV streaming or Video Streaming.

CameraStreamingManager.EncodingType.HW_VIDEO_WITH_HW_AUDIO_CODEC as the default CameraStreamingManager.EncodingType.

Parameters:

ctx - the Context of the App.

layout - the Layout of the rendering view

view - the View for displaying OpenGL rendering.

encodingType - the CameraStreamingManager.EncodingType of the CameraStreamingManager.

Method Detail

setStreamingStateListener

public final void setStreamingStateListener(CameraStreamingManager.StreamingStateListener listener)

Registers a listener to be notified when the CameraStreamingManager's State is updated.

Parameters:

listener - the listener to notify

setStreamingSessionListener

public final void setStreamingSessionListener(CameraStreamingManager.StreamingSessionListener listener)

Registers a listener to be notified when the CameraStreamingManager's Session is changed.

Parameters:

listener - the listener to notify

setStreamingPreviewCallback

public final void setStreamingPreviewCallback(StreamingPreviewCallback callback)

Registers a callback to be invoked when a Preview Frame arrives.

Parameters:

callback - the callback for NV21 Preview Frame

setSurfaceTextureCallback

public final void setSurfaceTextureCallback(SurfaceTextureCallback callback)

Registers a callback to handle(filter) the display source to be rendered.

Parameters:

callback - the callback for SurfaceTexture

setStreamStatusCallback

public final void setStreamStatusCallback(StreamStatusCallback callback)

Registers a callback to notify StreamingProfile.StreamStatus, including audioFps, videoFps and totalAVBitrate.

You should calls this after prepare(CameraStreamingSetting, StreamingProfile).

Parameters:

callback - the callback for StreamStatus

setVideoFilterType

public final void setVideoFilterType(com.pili.pldroid.streaming.CameraStreamingSetting.VIDEO_FILTER_TYPE filterType)

updateFaceBeautySetting

public final void updateFaceBeautySetting(com.pili.pldroid.streaming.CameraStreamingSetting.FaceBeautySetting fbSetting)

prepare

public boolean prepare(StreamingProfile profile)

Prepare the StreamingProfile to CameraStreamingManager, only for pure Audio Streaming.

Should be called before onResume().

Parameters:

profile - the StreamingProfile for CameraStreamingManager.

Returns:

true means prepare successfully; otherwise false, that's to say, onPrepare have been invoked.

prepare

public boolean prepare(CameraStreamingSetting setting,
                       StreamingProfile profile)

Prepare the CameraStreamingSetting and StreamingProfile to CameraStreamingManager.

Must be called before onResume().

Parameters:

setting - the CameraStreamingSetting for CameraStreamingManager.

profile - the StreamingProfile for CameraStreamingManager.

Returns:

true means prepare successfully; otherwise false, that's to say, onPrepare have been invoked.

prepare

public boolean prepare(CameraStreamingSetting camSetting,
                       MicrophoneStreamingSetting microphoneSetting,
                       WatermarkSetting wmSetting,
                       StreamingProfile profile)

prepare

public boolean prepare(CameraStreamingSetting camSetting,
                       MicrophoneStreamingSetting microphoneSetting,
                       StreamingProfile profile)

resume

public boolean resume()

Resume the CameraStreamingManager.

It should be called after prepare(com.pili.pldroid.streaming.StreamingProfile).

In will open the camera asynchronously with video streaming. Some states by CameraStreamingManager.StreamingStateListener.onStateChanged(int, java.lang.Object) will be invoked as following:

1. CameraStreamingManager.STATE.READY
2. CameraStreamingManager.STATE.NO_SUPPORTED_PREVIEW_SIZE
3. CameraStreamingManager.STATE.OPEN_CAMERA_FAIL

It is highly recommended the method called in the onResume of Activity.

Returns:

true means resume successfully; otherwise false, means the device hasn't support camera feature.

pause

public void pause()

Pause the CameraStreamingManager.

It should be called when the current Activity or others be PAUSED state.

stopStreaming() - release camera - release other resources

The background-streaming is the unsupported behavior at present.

destroy

public void destroy()

Destroy some non-critical resources.

onPrepare

public boolean onPrepare(StreamingProfile profile)

Deprecated. replaced by prepare(StreamingProfile)

onPrepare

public boolean onPrepare(CameraStreamingSetting setting,
                         StreamingProfile profile)

Deprecated. replaced by prepare(CameraStreamingSetting, StreamingProfile)

onResume

public boolean onResume()

Deprecated. replaced by resume()

onPause

public void onPause()

Deprecated. replaced by pause()

onDestroy

public void onDestroy()

Deprecated. replaced by destroy()

startStreaming

public boolean startStreaming()

Start Streaming.

Must be called after getting CameraStreamingManager.STATE.READY message and in non-ui thread.

The following situations maybe cause the failed start:

1. Being in Streaming state already.
2. Streaming url is invalid.
3. Camera is unactivated.
4. Connect is failed. CameraStreamingManager.STATE.IOERROR will be invoked.

Returns:

true operate successfully; otherwise false.

stopStreaming

public boolean stopStreaming()

Stop Streaming.

It will close the Streaming-Connection and release some resources. And what's more, CameraStreamingManager.STATE.SHUTDOWN will be invoked.

The following situations may cause the failed stop:

1. Being in non-streaming state.
2. Un-initialized
3. Camera is in switching state.

Returns:

true operate successfully; otherwise false.

turnLightOff

public boolean turnLightOff()

Turn flashlight off. Set the flashlight to FLASH_MODE_OFF mode.

The following situations will cause the failed invocation:

1. Camera is unactivated
2. The handset don't support flashlight
3. The handset don't support FLASH_MODE_OFF mode

Returns:

true if operate successfully. Otherwise, false.

turnLightOn

public boolean turnLightOn()

Turn flashlight on. Set the flashlight to FLASH_MODE_TORCH mode.

The following situations will cause the failed invocation:

1. Camera is unactivated
2. The handset don't support flashlight
3. The handset don't support FLASH_MODE_TORCH mode

Returns:

true if operate successfully. Otherwise, false.

switchCamera

public boolean switchCamera()

Switch to another camera. Only support CAMERA_FACING_FRONT and CAMERA_FACING_BACK at present. It is an undefined behavior if there is the third camera. It will stop video streaming, but won't stop the audio streaming during the switchCamera() in AV EncodingType under the CameraStreamingManager.STATE.STREAMING state. And then, recovery the video streaming after the request camera been activated as soon as possible. The following situations will cause the failed invocation:

1. there isn't activated camera now
2. some internal muxer states
3. handset has only one camera device
4. there is a camera under switching state

Returns:

true if operate successfully. Otherwise, false.

captureFrame

public void captureFrame(int width,
                         int height,
                         FrameCapturedCallback callback)

Send a capture frame request and FrameCapturedCallback.onFrameCaptured(Bitmap) will be invoked after finishing capturing.

Parameters:

width - width of the capturing request in pixels.

height - height of the capturing request in pixels.

callback - the callback for capture frame.

setNativeLoggingEnabled

public void setNativeLoggingEnabled(boolean enabled)

Enable or disable the native logs.

It is highly recommended that disable the native logs in the release version.

Parameters:

enabled - true means enable the log; false means disable the native log.

notifyProfileChanged

public void notifyProfileChanged(StreamingProfile profile)

Deprecated. instead by setStreamingProfile(com.pili.pldroid.streaming.StreamingProfile)

setStreamingProfile

public void setStreamingProfile(StreamingProfile profile)

update the StreamingProfile which associated with CameraStreamingManager.

Parameters:

profile - the new StreamingProfile.

Throws:

java.lang.IllegalArgumentException - if profile is null.

updateEncodingType

public void updateEncodingType(CameraStreamingManager.EncodingType newType)

update the EncodingType.

Parameters:

newType - the new EncodingType.

Throws:

java.lang.IllegalArgumentException - if newType is null or same as current CameraStreamingManager.EncodingType.

notifyActivityOrientationChanged

public void notifyActivityOrientationChanged()

Notify Orientation of Activity Changed. It's useful to implement the Orientation dynamically change.

doSingleTapUp

public void doSingleTapUp(int x,
                          int y)

Do single tap to trigger the Camera#autoFocus(Camera.AutoFocusCallback).

You should call this after getting CameraStreamingManager.STATE.READY.

Parameters:

x - X axis of a motion event.

y - Y axis of a motion event.

setFocusAreaIndicator

public void setFocusAreaIndicator(ViewGroup indicatorLayout,
                                  View indicator)

Sets the indicator for focusing UI.

You should call this after getting CameraStreamingManager.STATE.READY.

Parameters:

indicatorLayout - the layout of the indicator

indicator - the indicator for Focus UI

setZoomValue

public void setZoomValue(int value)

Sets current zoom value. If the camera is zoomed (value > 0), the preview and streaming will take effect. Applications should check isZoomSupported() before using this method.

You should call this after getting CameraStreamingManager.STATE.READY.

Parameters:

value - zoom value. The valid range is 0 to getMaxZoom().

getMaxZoom

public int getMaxZoom()

Gets the maximum zoom value allowed for preview and streaming. This is the maximum value that applications can set to setZoomValue(int). Applications should call isZoomSupported() before using this method. This value may change in different preview size. Applications should call this again after setting preview size.

You should call this after getting CameraStreamingManager.STATE.READY.

Returns:

the maximum zoom value supported by the camera.

getZoom

public int getZoom()

Gets current zoom value. You should check isZoomSupported() before using this method.

You should call this after getting CameraStreamingManager.STATE.READY.

Returns:

the current zoom value. The range is 0 to getMaxZoom(). 0 means the camera is not zoomed.

isZoomSupported

public boolean isZoomSupported()

Returns true if zoom is supported. Applications should call this before using other zoom methods.

You should call this after getting CameraStreamingManager.STATE.READY.

Returns:

true if zoom is supported.

mute

public void mute(boolean enable)

Enable or disable the mute feature.

You should call this after prepare(CameraStreamingSetting, StreamingProfile)

Parameters:

enable - true means mute; false means unmute.

onEncoderExitDone

public void onEncoderExitDone()

muxerStatusUpdate

public void muxerStatusUpdate(EncodingConfig.MUXER_STATE muxerState)

muxerStatusUpdate

public void muxerStatusUpdate(EncodingConfig.MUXER_STATE muxerState,
                              java.lang.Object extra)

networkBlocking

public void networkBlocking()

doPauseStreaming

public void doPauseStreaming()

doResumeStreaming

public void doResumeStreaming()

frameAvailable

public void frameAvailable(int textureId,
                           SurfaceTexture texture,
                           boolean needCustomTextTarget)

onPreviewFrame

public void onPreviewFrame(byte[] bytes,
                           Camera camera,
                           long ts)

notifyFirstEncodingFrame

public void notifyFirstEncodingFrame()

notifyFirstEncodingAudioFrame

public void notifyFirstEncodingAudioFrame(boolean isMicrophoneOpenFailed)

openCameraDeviceFailed

public void openCameraDeviceFailed(int camId)

notifyPrvSizeChanged

public void notifyPrvSizeChanged(Camera.Size size)

noNV21PrvFormat

public void noNV21PrvFormat()

onPreviewSizeSelected

public Camera.Size onPreviewSizeSelected(java.util.List<Camera.Size> list)

onPreviewFrame

public void onPreviewFrame(byte[] bytes,
                           long ts)