Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation
RdsData

RdsData Class Reference

Constructors

Instance Methods

Constructors

new RdsData(parameters)

Initializes an instance of RdsData.

Instance Methods

rdsData.getCT() ⇒ String

Get the CT

Kind: Instance method of RdsData
Returns: String - the KEY_CT value

rdsData.getPI() ⇒ String

Get the PI

Kind: Instance method of RdsData
Returns: String - the KEY_PI value

rdsData.getPS() ⇒ String

Get the PS

Kind: Instance method of RdsData
Returns: String - the KEY_PS value

rdsData.getPTY() ⇒ Number

Get the PTY

Kind: Instance method of RdsData
Returns: Number - the KEY_PTY value

rdsData.getREG() ⇒ String

Get the REG

Kind: Instance method of RdsData
Returns: String - the KEY_REG value

rdsData.getRT() ⇒ String

Get the RT

Kind: Instance method of RdsData
Returns: String - the KEY_RT value

rdsData.getTA() ⇒ Boolean

Get the TA

Kind: Instance method of RdsData
Returns: Boolean - the KEY_TA value

rdsData.getTP() ⇒ Boolean

Get the TP

Kind: Instance method of RdsData
Returns: Boolean - the KEY_TP value

rdsData.setCT(ct) ⇒ RdsData

Set the CT

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
ct String The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD - The desired CT. {'string_min_length': 24, 'string_max_length': 24}

rdsData.setPI(pi) ⇒ RdsData

Set the PI

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
pi String Program Identification - the call sign for the radio station - The desired PI. {'string_min_length': 0, 'string_max_length': 6}

rdsData.setPS(ps) ⇒ RdsData

Set the PS

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
ps String Program Service Name - The desired PS. {'string_min_length': 0, 'string_max_length': 8}

rdsData.setPTY(pty) ⇒ RdsData

Set the PTY

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
pty Number The program type - The region should be used to differentiate between EU and North America program types - The desired PTY. {'num_min_value': 0, 'num_max_value': 31}

rdsData.setREG(reg) ⇒ RdsData

Set the REG

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
reg String Region - The desired REG. {'string_min_length': 1}

rdsData.setRT(rt) ⇒ RdsData

Set the RT

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
rt String Radio Text - The desired RT. {'string_min_length': 0, 'string_max_length': 64}

rdsData.setTA(ta) ⇒ RdsData

Set the TA

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
ta Boolean Traffic Announcement Identification - Indicates an ongoing traffic announcement - The desired TA.

rdsData.setTP(tp) ⇒ RdsData

Set the TP

Kind: Instance method of RdsData
Returns: RdsData - The class instance for method chaining.

ParamTypeDescription
tp Boolean Traffic Program Identification - Identifies a station that offers traffic - The desired TP.
View on GitHub.com
Previous Section Next Section