jellyfin-roku api docs Module: misc

Source:

source/utils/misc.brs, line 1

Methods

<static> AssocArrayEqual(Array1, Array2)

Parameters:

Name	Type	Description
`Array1`	object
`Array2`	object

Source:

source/utils/misc.brs, line 203

Returns:

Type: boolean

<static> arrayHasValue(arr, value)

Check if a specific value is inside of an array

Parameters:

Name	Type	Description
`arr`	object
`value`	dynamic

Source:

source/utils/misc.brs, line 246

Returns:

Type: boolean

<static> div_ceiling(a, b)

Parameters:

Name	Type	Description
`a`	integer
`b`	integer

Source:

source/utils/misc.brs, line 65

Returns:

Type: integer

<static> findNodeBySubtype(node, subtype)

Parameters:

Name	Type	Description
`node`	dynamic
`subtype`	dynamic

Source:

source/utils/misc.brs, line 195

Returns:

Type: dynamic

<static> formatTime(time)

Format time as 12 or 24 hour format based on system clock setting

Parameters:

Name	Type	Description
`time`	dynamic

Source:

source/utils/misc.brs, line 57

Returns:

Type: string

<static> getButton(msg [, subnode])

Parameters:

Name	Type	Argument	Default	Description
`msg`	dynamic
`subnode`	string	<optional>	"buttons"

Source:

source/utils/misc.brs, line 26

Returns:

Type: object

<static> getMinutes(ticks)

Converts ticks to minutes

Parameters:

Name	Type	Description
`ticks`	dynamic

Source:

source/utils/misc.brs, line 176

Returns:

Type: integer

<static> getMsgPicker(msg [, subnode])

Parameters:

Name	Type	Argument	Default	Description
`msg`	dynamic
`subnode`	string	<optional>	""

Source:

source/utils/misc.brs, line 18

Returns:

Type: object

<static> get_dialog_result(dialog, port)

Returns the item selected or -1 on backpress or other unhandled closure of dialog.

Parameters:

Name	Type	Description
`dialog`	dynamic
`port`	dynamic

Source:

source/utils/misc.brs, line 74

Returns:

Type: dynamic

<static> inArray(haystack, needle)

Search string array for search value. Return if it's found

Parameters:

Name	Type	Description
`haystack`	dynamic
`needle`	dynamic

Source:

source/utils/misc.brs, line 212

Returns:

Type: boolean

<static> isLocalhost(url)

Returns true if the string is a loopback, such as 'localhost' or '127.0.0.1'

Parameters:

Name	Type	Description
`url`	string

Source:

source/utils/misc.brs, line 160

Returns:

Type: boolean

<static> isNodeEvent(msg, field)

Parameters:

Name	Type	Description
`msg`	dynamic
`field`	string

Source:

source/utils/misc.brs, line 10

Returns:

Type: boolean

<static> isValid(input)

Returns whether or not passed value is valid

Parameters:

Name	Type	Description
`input`	dynamic

Source:

source/utils/misc.brs, line 133

Returns:

Type: boolean

<static> isValidAndNotEmpty(input)

Returns whether or not passed value is valid and not empty
Accepts a string, or any countable type (arrays and lists)

Parameters:

Name	Type	Description
`input`	dynamic

Source:

source/utils/misc.brs, line 142

Returns:

Type: boolean

<static> lastFocusedChild(obj)

Parameters:

Name	Type	Description
`obj`	object

Source:

source/utils/misc.brs, line 81

Returns:

Type: object

<static> leftPad(base, fill, length)

Parameters:

Name	Type	Description
`base`	string
`fill`	string
`length`	integer

Source:

source/utils/misc.brs, line 35

Returns:

Type: string

<static> message_dialog( [message])

Parameters:

Name	Type	Argument	Default	Description
`message`	string	<optional>	""

Source:

source/utils/misc.brs, line 97

Returns:

Type: dynamic

<static> option_dialog(options [, message] [, defaultSelection])

Parameters:

Name	Type	Argument	Default
`options`	dynamic
`message`	dynamic	<optional>	""
`defaultSelection`	dynamic	<optional>	0

Source:

source/utils/misc.brs, line 106

Returns:

Type: integer

<static> parseUrl(url)

Returns an array from a url - [ url, proto, host, port, subdir/params ]
If port or subdir are not found, an empty string will be added to the array
Proto must be declared or array will be empty

Parameters:

Name	Type	Description
`url`	string

Source:

source/utils/misc.brs, line 152

Returns:

Type: object

<static> roundNumber(f)

Rounds number to nearest integer

Parameters:

Name	Type	Description
`f`	float

Source:

source/utils/misc.brs, line 168

Returns:

Type: integer

<static> secondsToHuman(totalSeconds)

Parameters:

Name	Type	Description
`totalSeconds`	integer

Source:

source/utils/misc.brs, line 49

Returns:

Type: string

<static> setFieldTextValue(field, value)

Parameters:

Name	Type	Description
`field`	dynamic
`value`	dynamic

Source:

source/utils/misc.brs, line 125

Returns:

Type: void

<static> show_dialog(message [, options] [, defaultSelection])

Parameters:

Name	Type	Argument	Default
`message`	string
`options`	dynamic	<optional>	[]
`defaultSelection`	dynamic	<optional>	0

Source:

source/utils/misc.brs, line 90

Returns:

Type: integer

<static> shuffleArray(array)

Takes an array of data, shuffles the order, then returns the array
uses the Fisher-Yates shuffling algorithm

Parameters:

Name	Type	Description
`array`	object

Source:

source/utils/misc.brs, line 255

Returns:

Type: object

<static> standardize_jellyfin_url(url)

Take a jellyfin hostname and ensure it's a full url.
prepend http or https and append default ports, and remove excess slashes

Parameters:

Name	Type	Description
`url`	string

Source:

source/utils/misc.brs, line 117

Returns:

Type: dynamic

<static> startLoadingSpinner()

Source:

source/utils/misc.brs, line 225

Returns:

Type: void

<static> startMediaLoadingSpinner()

Source:

source/utils/misc.brs, line 231

Returns:

Type: void

<static> stopLoadingSpinner()

Source:

source/utils/misc.brs, line 237

Returns:

Type: void

<static> ticksToHuman(ticks)

Parameters:

Name	Type	Description
`ticks`	longinteger

Source:

source/utils/misc.brs, line 42

Returns:

Type: string

<static> toString(input)

Parameters:

Name	Type	Description
`input`	dynamic

Source:

source/utils/misc.brs, line 219

Returns:

Type: string

<static> versionChecker(versionToCheck, minVersionAccepted)

Returns whether or not a version number (e.g. 10.7.7) is greater or equal
to some minimum version allowed (e.g. 10.8.0)

Parameters:

Name	Type	Description
`versionToCheck`	string
`minVersionAccepted`	string

Source:

source/utils/misc.brs, line 187

Returns:

Type: dynamic