RdsData Class Reference
Constructors
Instance Methods
- getCT() ⇒
String - getPI() ⇒
String - getPS() ⇒
String - getPTY() ⇒
Number - getREG() ⇒
String - getRT() ⇒
String - getTA() ⇒
Boolean - getTP() ⇒
Boolean - setCT(ct) ⇒
RdsData - setPI(pi) ⇒
RdsData - setPS(ps) ⇒
RdsData - setPTY(pty) ⇒
RdsData - setREG(reg) ⇒
RdsData - setRT(rt) ⇒
RdsData - setTA(ta) ⇒
RdsData - setTP(tp) ⇒
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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| rt | String |
Radio Text - The desired RT. {'string_min_length': 0, 'string_max_length': 64} |