Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class MultiplexTransportConfig

Hierarchy

java.lang.Object
     com.smartdevicelink.transport.BaseTransportConfig

Package
com.smartdevicelink.transport

Fields

FLAG_MULTI_SECURITY_OFF

public static final int FLAG_MULTI_SECURITY_OFF

FLAG_MULTI_SECURITY_LOW

public static final int FLAG_MULTI_SECURITY_LOW
Constant Value
16

FLAG_MULTI_SECURITY_MED

public static final int FLAG_MULTI_SECURITY_MED
Constant Value
32

FLAG_MULTI_SECURITY_HIGH

public static final int FLAG_MULTI_SECURITY_HIGH
Constant Value
48

Inherited Fields

From Class Fields
com.smartdevicelink.transport.BaseTransportConfig shareConnection, iHeartBeatTimeout

Constructors

MultiplexTransportConfig( Context context, String appId )

public MultiplexTransportConfig(Context context,String appId)

Parameters

context
appId

MultiplexTransportConfig( Context context, String appId, int securityLevel )

public MultiplexTransportConfig(Context context,String appId,int securityLevel)

Parameters

context
appId
securityLevel

Methods

getTransportType()

Overridden abstract method which returns specific type of this transport configuration.

public com.smartdevicelink.transport.enums.TransportType getTransportType()

getContext()

Gets the context attached to this config

public android.content.Context getContext()

getService()

Gets the ComponentName of the router service attached to this config

public android.content.ComponentName getService()

setService( ComponentName service )

Supplies the config with the router service that should be bound to

public void setService(ComponentName service)

Parameters

service
the router service that should be bound to

setSecurityLevel( int securityLevel )

Sets the security level that should be used to verify a router service that is to be bound

public void setSecurityLevel(int securityLevel)

Parameters

securityLevel
the security level that will be used to perform certain tests

getSecurityLevel()

Get the securitly level that will be used to verify a router service before binding

public int getSecurityLevel()

setRequiresHighBandwidth( boolean requiresHighBandwidth )

Set whether or not this app requires the use of a transport that supports high bandwidth services. Common use is when an app uses the video/audio streaming services and there is no other integration that could be useful to the user.

For example:
1. If an app intends to perform audio or video streaming and does not wish to appear on the module when that isn't possible, a value of true should be sent.
2. If the same app wishes to appear on the module even when those services aren't available a value of true should be sent. In this case, the app could display a message prompting the user to "Please connect USB or Wifi" or it could have a separate integration like giving turn by turn directions in place of streaming the full navigation map.

public void setRequiresHighBandwidth(boolean requiresHighBandwidth)

Parameters

requiresHighBandwidth
whether the app should be treated as requiring a high bandwidth transport.

requiresHighBandwidth()

Get the setting from this config to see whether the app should be treated as requiring a high bandwidth transport.

public boolean requiresHighBandwidth()

setPrimaryTransports( java.util.List<com.smartdevicelink.transport.enums.TransportType> transports )

This will set the order in which a primary transport is determined to be accepted or not. In the case of previous protocol versions ( < 5.1)

public void setPrimaryTransports(java.util.List<com.smartdevicelink.transport.enums.TransportType> transports)

Parameters

transports
list of transports that can be used as primary

getPrimaryTransports()

Get the list of primary transports that are set to be accepted by this config

public java.util.List getPrimaryTransports()

setSecondaryTransports( java.util.List<com.smartdevicelink.transport.enums.TransportType> transports )

This will set the order in which a primary transport is determined to be accepted or not. In the case of previous protocol versions ( < 5.1)

public void setSecondaryTransports(java.util.List<com.smartdevicelink.transport.enums.TransportType> transports)

Parameters

transports
list of transports that can be used as secondary

getSecondaryTransports()

Get the list of secondary transports that are set to be accepted by this config

public java.util.List getSecondaryTransports()

setTransportListener( MultiplexTransportConfig.TransportListener listener )

Set a lister for transport events. Useful when connected high bandwidth services like audio or video streaming

public void setTransportListener(MultiplexTransportConfig.TransportListener listener)

Parameters

listener
the TransportListener that will be called back when transport events happen

getTransportListener()

Getter for the supplied transport listener

public com.smartdevicelink.transport.MultiplexTransportConfig.TransportListener getTransportListener()

Inherited Methods

From Class Methods
com.smartdevicelink.transport.BaseTransportConfig getTransportType, shareConnection, getHeartBeatTimeout, setHeartBeatTimeout
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section