-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #356 from smartdevicelink/feature/0198-media-skip-…
…indicators Add new API to SetMediaClockTimer
- Loading branch information
Showing
3 changed files
with
236 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* eslint-disable camelcase */ | ||
| /* | ||
| * Copyright (c) 2021, SmartDeviceLink Consortium, Inc. | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * Redistributions of source code must retain the above copyright notice, this | ||
| * list of conditions and the following disclaimer. | ||
| * | ||
| * Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following | ||
| * disclaimer in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * | ||
| * Neither the name of the SmartDeviceLink Consortium Inc. nor the names of | ||
| * its contributors may be used to endorse or promote products derived | ||
| * from this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| import { Enum } from '../../util/Enum.js'; | ||
|
|
||
| /** | ||
| * @typedef {Enum} SeekIndicatorType | ||
| * @property {Object} _MAP | ||
| */ | ||
| class SeekIndicatorType extends Enum { | ||
| /** | ||
| * Constructor for SeekIndicatorType. | ||
| * @class | ||
| * @since SmartDeviceLink 7.1.0 | ||
| */ | ||
| constructor () { | ||
| super(); | ||
| } | ||
|
|
||
| /** | ||
| * Get the enum value for TRACK. | ||
| * @returns {String} - The enum value. | ||
| */ | ||
| static get TRACK () { | ||
| return SeekIndicatorType._MAP.TRACK; | ||
| } | ||
|
|
||
| /** | ||
| * Get the enum value for TIME. | ||
| * @returns {String} - The enum value. | ||
| */ | ||
| static get TIME () { | ||
| return SeekIndicatorType._MAP.TIME; | ||
| } | ||
|
|
||
| /** | ||
| * Get the value for the given enum key | ||
| * @param {*} key - A key to find in the map of the subclass | ||
| * @returns {*} - Returns a value if found, or null if not found | ||
| */ | ||
| static valueForKey (key) { | ||
| return SeekIndicatorType._valueForKey(key, SeekIndicatorType._MAP); | ||
| } | ||
|
|
||
| /** | ||
| * Get the key for the given enum value | ||
| * @param {*} value - A primitive value to find the matching key for in the map of the subclass | ||
| * @returns {*} - Returns a key if found, or null if not found | ||
| */ | ||
| static keyForValue (value) { | ||
| return SeekIndicatorType._keyForValue(value, SeekIndicatorType._MAP); | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve all enumerated values for this class | ||
| * @returns {*} - Returns an array of values | ||
| */ | ||
| static values () { | ||
| return Object.values(SeekIndicatorType._MAP); | ||
| } | ||
| } | ||
|
|
||
| SeekIndicatorType._MAP = Object.freeze({ | ||
| 'TRACK': 'TRACK', | ||
| 'TIME': 'TIME', | ||
| }); | ||
|
|
||
| export { SeekIndicatorType }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* eslint-disable camelcase */ | ||
| /* | ||
| * Copyright (c) 2021, SmartDeviceLink Consortium, Inc. | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * Redistributions of source code must retain the above copyright notice, this | ||
| * list of conditions and the following disclaimer. | ||
| * | ||
| * Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following | ||
| * disclaimer in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * | ||
| * Neither the name of the SmartDeviceLink Consortium Inc. nor the names of | ||
| * its contributors may be used to endorse or promote products derived | ||
| * from this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| import { RpcStruct } from '../RpcStruct.js'; | ||
| import { SeekIndicatorType } from '../enums/SeekIndicatorType.js'; | ||
|
|
||
| /** | ||
| * The seek next / skip previous subscription buttons' content | ||
| */ | ||
| class SeekStreamingIndicator extends RpcStruct { | ||
| /** | ||
| * Initalizes an instance of SeekStreamingIndicator. | ||
| * @class | ||
| * @param {object} parameters - An object map of parameters. | ||
| * @since SmartDeviceLink 7.1.0 | ||
| */ | ||
| constructor (parameters) { | ||
| super(parameters); | ||
| } | ||
|
|
||
| /** | ||
| * Set the Type | ||
| * @param {SeekIndicatorType} type - The desired Type. | ||
| * @returns {SeekStreamingIndicator} - The class instance for method chaining. | ||
| */ | ||
| setType (type) { | ||
| this._validateType(SeekIndicatorType, type); | ||
| this.setParameter(SeekStreamingIndicator.KEY_TYPE, type); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Get the Type | ||
| * @returns {SeekIndicatorType} - the KEY_TYPE value | ||
| */ | ||
| getType () { | ||
| return this.getObject(SeekIndicatorType, SeekStreamingIndicator.KEY_TYPE); | ||
| } | ||
|
|
||
| /** | ||
| * Set the SeekTime | ||
| * @param {Number} time - If the type is TIME, this number of seconds may be present alongside the skip indicator. It will indicate the number of seconds that the currently playing media will skip forward or backward. - The desired SeekTime. | ||
| * {'num_min_value': 1, 'num_max_value': 99} | ||
| * @returns {SeekStreamingIndicator} - The class instance for method chaining. | ||
| */ | ||
| setSeekTime (time) { | ||
| this.setParameter(SeekStreamingIndicator.KEY_SEEK_TIME, time); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Get the SeekTime | ||
| * @returns {Number} - the KEY_SEEK_TIME value | ||
| */ | ||
| getSeekTime () { | ||
| return this.getParameter(SeekStreamingIndicator.KEY_SEEK_TIME); | ||
| } | ||
| } | ||
|
|
||
| SeekStreamingIndicator.KEY_TYPE = 'type'; | ||
| SeekStreamingIndicator.KEY_SEEK_TIME = 'seekTime'; | ||
|
|
||
| export { SeekStreamingIndicator }; |