com.smartdevicelink.managers.video

Class VideoStreamManager

java.lang.Object

com.smartdevicelink.managers.BaseSubManager

com.smartdevicelink.managers.video.VideoStreamManager

public class VideoStreamManager
extends BaseSubManager

Field Summary

Fields inherited from class com.smartdevicelink.managers.BaseSubManager

ERROR, internalInterface, LIMITED, READY, SETTING_UP, SHUTDOWN

Constructor Summary

Constructors

Constructor and Description
VideoStreamManager(ISdl internalInterface)

Method Summary

Modifier and Type	Method and Description
int	currentVideoStreamState() Gets the current video streaming state as defined in @StreamingStateMachine
void	dispose() Stops streaming, ends video streaming service and removes service listeners.
VideoStreamingParameters	getLastCachedStreamingParameters()
boolean	isPaused() Check if video streaming has been paused due to app moving to background or manually stopped
boolean	isServiceActive() Check if a video service is currently active
boolean	isStreaming() Check if video is currently streaming and visible
protected void	onTransportUpdate(List<TransportRecord> connectedTransports, boolean audioStreamTransportAvail, boolean videoStreamTransportAvail) Transport status has been updated
void	resumeStreaming() Resumes streaming after calling
void	start(CompletionListener listener) Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.
void	startRemoteDisplayStream(Context context, Class<? extends SdlRemoteDisplay> remoteDisplayClass, VideoStreamingParameters parameters, boolean encrypted) Deprecated.
void	startRemoteDisplayStream(Context context, Class<? extends SdlRemoteDisplay> remoteDisplayClass, VideoStreamingParameters parameters, boolean encrypted, VideoStreamingRange supportedLandscapeStreamingRange, VideoStreamingRange supportedPortraitStreamingRange) Starts streaming a remote display to the module if there is a connected session.
protected void	startStreaming(VideoStreamingParameters parameters, boolean encrypted) Starts video service, sets up encoder, haptic manager, and remote display.
protected IVideoStreamListener	startVideoStream(VideoStreamingParameters params, SdlSession session)
void	stopStreaming() Stops streaming from the remote display.
protected boolean	stopVideoStream()

Methods inherited from class com.smartdevicelink.managers.BaseSubManager

getState, handleTransportUpdated, transitionToState

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoStreamManager

public VideoStreamManager(ISdl internalInterface)

Method Detail

start

public void start(CompletionListener listener)

Description copied from class: BaseSubManager

Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Overrides:

start in class BaseSubManager

Parameters:

listener - CompletionListener that is called once the BaseSubManager's state is READY, LIMITED, or ERROR

startRemoteDisplayStream

public void startRemoteDisplayStream(Context context,
                                     Class<? extends SdlRemoteDisplay> remoteDisplayClass,
                                     VideoStreamingParameters parameters,
                                     boolean encrypted,
                                     VideoStreamingRange supportedLandscapeStreamingRange,
                                     VideoStreamingRange supportedPortraitStreamingRange)

Starts streaming a remote display to the module if there is a connected session. This method of streaming requires the device to be on API level 19 or higher Two ranges (supportedLandscapeStreamingRange and supportedLandscapeStreamingRange) can be provided with image dimension ranges and aspect ratio ranges that your remoteDisplay class supports. If the module's screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode, or picture-in-picture), your remoteDisplay will be resized to the new screen size. If either range is `null`, the default is to support all streaming ranges of that format (landscape or portrait). If you wish to disable support for streaming in a given format (landscape or portrait), set a VideoStreamingRange with all `0` values. NOTE If both supportedLandscapeStreamingRange and supportedLandscapeStreamingRange are disabled then the video will not stream. Any changes to screen size will notify the onViewResized method you have implemented in your remoteDisplay class.

Parameters:

context - a context that can be used to create the remote display

remoteDisplayClass - class object of the remote display. This class will be used to create an instance of the remote display and will be projected to the module

parameters - streaming parameters to be used when streaming. If null is sent in, the default/optimized options will be used. If you are unsure about what parameters to be used it is best to just send null and let the system determine what works best for the currently connected module.

encrypted - a flag of if the stream should be encrypted. Only set if you have a supplied encryption library that the module can understand.

supportedLandscapeStreamingRange - constraints for vehicle display : min/max aspect ratio, min/max resolutions, max diagonal size.

supportedPortraitStreamingRange - constraints for vehicle display : min/max aspect ratio, min/max resolutions, max diagonal size.

startRemoteDisplayStream

@Deprecated
public void startRemoteDisplayStream(Context context,
                                                 Class<? extends SdlRemoteDisplay> remoteDisplayClass,
                                                 VideoStreamingParameters parameters,
                                                 boolean encrypted)

Deprecated.

Starts streaming a remote display to the module if there is a connected session. This method of streaming requires the device to be on API level 19 or higher

Parameters:

context - a context that can be used to create the remote display

remoteDisplayClass - class object of the remote display. This class will be used to create an instance of the remote display and will be projected to the module

parameters - streaming parameters to be used when streaming. If null is sent in, the default/optimized options will be used. If you are unsure about what parameters to be used it is best to just send null and let the system determine what works best for the currently connected module.

encrypted - a flag of if the stream should be encrypted. Only set if you have a supplied encryption library that the module can understand.

startStreaming

protected void startStreaming(VideoStreamingParameters parameters,
                              boolean encrypted)

Starts video service, sets up encoder, haptic manager, and remote display. Begins streaming the remote display.

Parameters:

parameters - Video streaming parameters including: codec which will be used for streaming (currently, only VideoStreamingCodec.H264 is accepted), height and width of the video in pixels.

encrypted - Specify true if packets on this service have to be encrypted

stopStreaming

public void stopStreaming()

Stops streaming from the remote display. To restart, call

See Also:

resumeStreaming()

resumeStreaming

public void resumeStreaming()

Resumes streaming after calling

See Also:

followed by a call to, stopStreaming()

dispose

public void dispose()

Stops streaming, ends video streaming service and removes service listeners.

Overrides:

dispose in class BaseSubManager

isServiceActive

public boolean isServiceActive()

Check if a video service is currently active

Returns:

boolean (true = active, false = inactive)

isStreaming

public boolean isStreaming()

Check if video is currently streaming and visible

Returns:

boolean (true = yes, false = no)

isPaused

public boolean isPaused()

Check if video streaming has been paused due to app moving to background or manually stopped

Returns:

boolean (true = not paused, false = paused)

currentVideoStreamState

public int currentVideoStreamState()

Gets the current video streaming state as defined in @StreamingStateMachine

Returns:

int representing StreamingStateMachine.StreamingState

onTransportUpdate

protected void onTransportUpdate(List<TransportRecord> connectedTransports,
                                 boolean audioStreamTransportAvail,
                                 boolean videoStreamTransportAvail)

Description copied from class: BaseSubManager

Transport status has been updated

Overrides:

onTransportUpdate in class BaseSubManager

Parameters:

connectedTransports - currently connected transports

audioStreamTransportAvail - if there is a transport that could be used to carry the audio service

videoStreamTransportAvail - if there is a transport that could be used to carry the video service

getLastCachedStreamingParameters

public VideoStreamingParameters getLastCachedStreamingParameters()

startVideoStream

protected IVideoStreamListener startVideoStream(VideoStreamingParameters params,
                                                SdlSession session)

stopVideoStream

protected boolean stopVideoStream()