2023-10-27 02:19:51 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width" >
< title > jellyfin-roku api docs Source: source/utils/deviceCapabilities.brs< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.dark.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.darkly.css" >
< / head >
< body >
< div class = "navbar navbar-default navbar-fixed-top " >
< div class = "container" >
< div class = "navbar-header" >
< a class = "navbar-brand" href = "index.html" > jellyfin-roku api docs< / a >
< button class = "navbar-toggle" type = "button" data-toggle = "collapse" data-target = "#topNavigation" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< / div >
< div class = "navbar-collapse collapse" id = "topNavigation" >
< ul class = "nav navbar-nav" >
< li class = "dropdown" >
< a href = "modules.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Modules< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
2023-11-01 02:31:41 +00:00
< li > < a href = "module-AlbumData.html" > AlbumData< / a > < / li > < li > < a href = "module-AlbumGrid.html" > AlbumGrid< / a > < / li > < li > < a href = "module-AlbumTrackList.html" > AlbumTrackList< / a > < / li > < li > < a href = "module-AlbumView.html" > AlbumView< / a > < / li > < li > < a href = "module-Alpha.html" > Alpha< / a > < / li > < li > < a href = "module-ArtistView.html" > ArtistView< / a > < / li > < li > < a href = "module-AudioPlayer.html" > AudioPlayer< / a > < / li > < li > < a href = "module-AudioPlayerView.html" > AudioPlayerView< / a > < / li > < li > < a href = "module-AudioTrackListItem.html" > AudioTrackListItem< / a > < / li > < li > < a href = "module-ButtonGroupHoriz.html" > ButtonGroupHoriz< / a > < / li > < li > < a href = "module-ButtonGroupVert.html" > ButtonGroupVert< / a > < / li > < li > < a href = "module-ChannelData.html" > ChannelData< / a > < / li > < li > < a href = "module-CollectionData.html" > CollectionData< / a > < / li > < li > < a href = "module-ConfigData.html" > ConfigData< / a > < / li > < li > < a href = "module-ConfigItem.html" > ConfigItem< / a > < / li > < li > < a href = "module-ConfigList.html" > ConfigList< / a > < / li > < li > < a href = "module-ExtrasItem.html" > ExtrasItem< / a > < / li > < li > < a href = "module-ExtrasRowList.html" > ExtrasRowList< / a > < / li > < li > < a href = "module-FavoriteItemsTask.html" > FavoriteItemsTask< / a > < / li > < li > < a href = "module-FolderData.html" > FolderData< / a > < / li > < li > < a href = "module-GetFiltersTask.html" > GetFiltersTask< / a > < / li > < li > < a href = "module-GetNextEpisodeTask.html" > GetNextEpisodeTask< / a > < / li > < li > < a href = "module-GetPlaybackInfoTask.html" > GetPlaybackInfoTask< / a > < / li > < li > < a href = "module-GetShuffleEpisodesTask.html" > GetShuffleEpisodesTask< / a > < / li > < li > < a href = "module-GridItem.html" > GridItem< / a > < / li > < li > < a href = "module-GridItemSmall.html" > GridItemSmall< / a > < / li > < li > < a href = "module-Home.html" > Home< / a > < / li > < li > < a href = "module-HomeData.html" > HomeData< / a > < / li > < li > < a href = "module-HomeItem.html" > HomeItem< / a > < / li > < li > < a href = "module-HomeRows.html" > HomeRows< / a > < / li > < li > < a href = "module-IconButton.html" > IconButton< / a > < / li > < li > < a href = "module-Image.html" > Image< / a > < / li > < li > < a href = "module-ImageData.html" > ImageData< / a > < / li > < li > < a href = "module-IntegerKeyboard.html" > IntegerKeyboard< / a > < / li > < li > < a href = "module-ItemGrid.html" > ItemGrid< / a > < / li > < li > < a href = "module-ItemGridOptions.html" > ItemGridOptions< / a > < / li > < li > < a href = "module-Items.html" > Items< / a > < / li > < li > < a href = "module-JFButton.html" > JFButton< / a > < / li > < li > < a href = "module-JFButtons.html" > JFButtons< / a > < / li > < li > < a href = "module-JFGroup.html" > JFGroup< / a > < / li > < li > < a href = "module-JFMessageDialog.html" > JFMessageDialog< / a > < / li > < li > < a href = "module-JFOverhang.html" > JFOverhang< / a > < / li > < li > < a href = "module-JFScene.html" > JFScene< / a > < / li > < li > < a href = "module-JFScreen.html" > JFScreen< / a > < / li > < li > < a href = "module-JFServer.html" > JFServer< / a > < / li > < li > < a href = "module-JFVideo.html" > JFVideo< / a > < / li > < li > < a href = "module-ListPoster.html" > ListPoster< / a > < / li > < li > < a href = "module-LoadChannelsTask.html" > LoadChannelsTask< / a > < / li > < li > < a href = "module-LoadItemsTask.html" > LoadItemsTask< / a > < / li > < li > < a href = "module-LoadItemsTask2.html" > LoadItemsTask2< / a > < / li > < li > < a href = "module-LoadPhotoTask.html" > LoadPhotoTask< / a > < / li > < li > < a href = "module-LoadProgramDetailsTask.html" > LoadProgramDetailsTask< / a > < / li > < li > < a href = "module-LoadScreenSaverTimeoutTask.html" > LoadScreenSaverTimeoutTask< / a > < / li > < li > < a href = "module-LoadSheduleTask.html" > LoadSheduleTask< / a > < / li > < li > < a href = "module-LoadVideoContentTask.html" > LoadVideoContentTask< / a > < / li > < li > < a href = "module-LoginScene.html" > LoginScene< / a > < / li > < li > < a href = "module-Main.html" > Main< / a > < / li > < li > < a href = "module-MovieData.html" > MovieData< / a > < / li > < li > < a href = "module-MovieDetails.html" > MovieDetails< / a > < / li > < li > < a href = "module-MovieLibraryView.html" > MovieLibraryView< / a > < / li > < li > < a href = "module-MovieOptions.html" > MovieOptions< / a > < / li > < li > < a href = "module-MusicAlbumData.html" > MusicAlbumData< / a > < / li > < li > < a href = "module-MusicAlbumSongListData.html" > MusicAlbumSongListData< / a > < / li > < li > < a href = "module-MusicArtistData.html" > MusicArtistData< / a > < / li > < li > < a href = "module-MusicArtistGridItem.html" > MusicArtistGridItem< / a > < / li > < li > < a href = "module-MusicLibraryView.html" > MusicLibraryView< / a > < / li > < li > < a href = "module-MusicSongData.html" > MusicSongData< / a > < / li > < li > < a href = "module-OptionNode.html" > OptionNode<
2023-10-27 02:19:51 +00:00
< / ul >
< / li >
< / ul >
< div class = "col-sm-3 col-md-3" >
< form class = "navbar-form" role = "search" >
< div class = "input-group" >
< input type = "text" class = "form-control" placeholder = "Search" name = "q" id = "search-input" >
< div class = "input-group-btn" >
< button class = "btn btn-default" id = "search-submit" > < i class = "glyphicon glyphicon-search" > < / i > < / button >
< / div >
< / div >
< / form >
< / div >
< / div >
< / div >
< / div >
< div class = "container" id = "toc-content" >
< div class = "row" >
< div class = "col-md-12" >
< div id = "main" >
< h1 class = "page-title" > Source: source/utils/deviceCapabilities.brs< / h1 >
< section >
< article >
< pre
class="sunlight-highlight-javascript linenums">import "pkg:/source/utils/misc.brs"
2023-10-06 03:18:36 +00:00
import "pkg:/source/api/baserequest.brs"
'Device Capabilities for Roku.
'This will likely need further tweaking
function getDeviceCapabilities() as object
return {
"PlayableMediaTypes": [
"Audio",
"Video",
"Photo"
],
"SupportedCommands": [],
"SupportsPersistentIdentifier": true,
"SupportsMediaControl": false,
"SupportsContentUploading": false,
"SupportsSync": false,
"DeviceProfile": getDeviceProfile(),
"AppStoreUrl": "https://channelstore.roku.com/details/cc5e559d08d9ec87c5f30dcebdeebc12/jellyfin"
}
end function
' Send Device Profile information to server
sub PostDeviceProfile()
profile = getDeviceCapabilities()
req = APIRequest("/Sessions/Capabilities/Full")
req.SetRequest("POST")
print "profile =", profile
print "profile.DeviceProfile =", profile.DeviceProfile
print "profile.DeviceProfile.CodecProfiles ="
for each prof in profile.DeviceProfile.CodecProfiles
print prof
for each cond in prof.Conditions
print cond
end for
end for
print "profile.DeviceProfile.ContainerProfiles =", profile.DeviceProfile.ContainerProfiles
print "profile.DeviceProfile.DirectPlayProfiles ="
for each prof in profile.DeviceProfile.DirectPlayProfiles
print prof
end for
print "profile.DeviceProfile.SubtitleProfiles ="
for each prof in profile.DeviceProfile.SubtitleProfiles
print prof
end for
print "profile.DeviceProfile.TranscodingProfiles ="
for each prof in profile.DeviceProfile.TranscodingProfiles
print prof
if isValid(prof.Conditions)
for each condition in prof.Conditions
print condition
end for
end if
end for
print "profile.PlayableMediaTypes =", profile.PlayableMediaTypes
print "profile.SupportedCommands =", profile.SupportedCommands
postJson(req, FormatJson(profile))
end sub
function getDeviceProfile() as object
2023-11-04 19:11:14 +00:00
globalDevice = m.global.device
return {
"Name": "Official Roku Client",
"Id": globalDevice.id,
"Identification": {
"FriendlyName": globalDevice.friendlyName,
"ModelNumber": globalDevice.model,
"SerialNumber": "string",
"ModelName": globalDevice.name,
"ModelDescription": "Type: " + globalDevice.modelType,
"Manufacturer": globalDevice.modelDetails.VendorName
},
"FriendlyName": globalDevice.friendlyName,
"Manufacturer": globalDevice.modelDetails.VendorName,
"ModelName": globalDevice.name,
"ModelDescription": "Type: " + globalDevice.modelType,
"ModelNumber": globalDevice.model,
"SerialNumber": globalDevice.serial,
"MaxStreamingBitrate": 120000000,
"MaxStaticBitrate": 100000000,
"MusicStreamingTranscodingBitrate": 192000,
"DirectPlayProfiles": GetDirectPlayProfiles(),
"TranscodingProfiles": getTranscodingProfiles(),
"ContainerProfiles": getContainerProfiles(),
"CodecProfiles": getCodecProfiles(),
"SubtitleProfiles": getSubtitleProfiles()
}
end function
function GetDirectPlayProfiles() as object
globalUserSettings = m.global.session.user.settings
directPlayProfiles = []
2023-10-06 03:18:36 +00:00
di = CreateObject("roDeviceInfo")
2023-11-04 19:11:14 +00:00
' all possible containers
supportedCodecs = {
mp4: {
audio: [],
video: []
},
hls: {
audio: [],
video: []
},
mkv: {
audio: [],
video: []
},
ism: {
audio: [],
video: []
},
dash: {
audio: [],
video: []
},
ts: {
audio: [],
video: []
}
}
' all possible codecs (besides those restricted by user settings)
videoCodecs = ["h264", "mpeg4 avc", "vp8", "vp9", "h263", "mpeg1"]
audioCodecs = ["mp3", "mp2", "pcm", "lpcm", "wav", "ac3", "ac4", "aiff", "wma", "flac", "alac", "aac", "opus", "dts", "wmapro", "vorbis", "eac3", "mpg123"]
' check if hevc is disabled
if globalUserSettings["playback.compatibility.disablehevc"] = false
videoCodecs.push("hevc")
end if
' check video codecs for each container
for each container in supportedCodecs
for each videoCodec in videoCodecs
if di.CanDecodeVideo({ Codec: videoCodec, Container: container }).Result
if videoCodec = "hevc"
supportedCodecs[container]["video"].push("hevc")
supportedCodecs[container]["video"].push("h265")
else
' device profile string matches codec string
supportedCodecs[container]["video"].push(videoCodec)
end if
end if
end for
end for
2023-10-06 03:18:36 +00:00
2023-11-04 19:11:14 +00:00
' user setting overrides
if globalUserSettings["playback.mpeg4"]
for each container in supportedCodecs
supportedCodecs[container]["video"].push("mpeg4")
end for
end if
if globalUserSettings["playback.mpeg2"]
for each container in supportedCodecs
supportedCodecs[container]["video"].push("mpeg2video")
end for
end if
' video codec overrides
' these codecs play fine but are not correctly detected using CanDecodeVideo()
if di.CanDecodeVideo({ Codec: "av1" }).Result
' codec must be checked by itself or the result will always be false
for each container in supportedCodecs
supportedCodecs[container]["video"].push("av1")
end for
end if
' check audio codecs for each container
for each container in supportedCodecs
for each audioCodec in audioCodecs
if di.CanDecodeAudio({ Codec: audioCodec, Container: container }).Result
supportedCodecs[container]["audio"].push(audioCodec)
end if
end for
end for
2023-11-05 20:36:11 +00:00
' remove audio codecs not supported as standalone audio files (opus)
' also add aac back to the list so it gets added to the direct play profile
audioCodecs = ["aac", "mp3", "mp2", "pcm", "lpcm", "wav", "ac3", "ac4", "aiff", "wma", "flac", "alac", "aac", "dts", "wmapro", "vorbis", "eac3", "mpg123"]
2023-11-04 19:11:14 +00:00
' check audio codecs with no container
supportedAudio = []
for each audioCodec in audioCodecs
if di.CanDecodeAudio({ Codec: audioCodec }).Result
supportedAudio.push(audioCodec)
end if
end for
' build return array
for each container in supportedCodecs
videoCodecString = supportedCodecs[container]["video"].Join(",")
if videoCodecString < > ""
containerString = container
if container = "mp4"
containerString = "mp4,mov,m4v"
else if container = "mkv"
containerString = "mkv,webm"
end if
directPlayProfiles.push({
"Container": containerString,
"Type": "Video",
"VideoCodec": videoCodecString,
"AudioCodec": supportedCodecs[container]["audio"].Join(",")
})
end if
end for
directPlayProfiles.push({
"Container": supportedAudio.Join(","),
"Type": "Audio"
})
return directPlayProfiles
end function
function getTranscodingProfiles() as object
globalUserSettings = m.global.session.user.settings
transcodingProfiles = []
di = CreateObject("roDeviceInfo")
transcodingContainers = ["mp4", "ts"]
2023-10-06 03:18:36 +00:00
' use strings to preserve order
mp4AudioCodecs = "aac"
mp4VideoCodecs = "h264"
tsAudioCodecs = "aac"
tsVideoCodecs = "h264"
' does the users setup support surround sound?
maxAudioChannels = "2" ' jellyfin expects this as a string
' in order of preference from left to right
2023-11-04 19:11:14 +00:00
audioCodecs = ["mp3", "vorbis", "opus", "flac", "alac", "ac4", "pcm", "wma", "wmapro"]
2023-10-06 03:18:36 +00:00
surroundSoundCodecs = ["eac3", "ac3", "dts"]
2023-11-04 19:11:14 +00:00
if globalUserSettings["playback.forceDTS"] = true
2023-10-06 03:18:36 +00:00
surroundSoundCodecs = ["dts", "eac3", "ac3"]
end if
2023-11-04 19:11:14 +00:00
surroundSoundCodec = invalid
2023-10-06 03:18:36 +00:00
if di.GetAudioOutputChannel() = "5.1 surround"
maxAudioChannels = "6"
for each codec in surroundSoundCodecs
if di.CanDecodeAudio({ Codec: codec, ChCnt: 6 }).Result
2023-11-04 19:11:14 +00:00
surroundSoundCodec = codec
2023-10-06 03:18:36 +00:00
if di.CanDecodeAudio({ Codec: codec, ChCnt: 8 }).Result
maxAudioChannels = "8"
end if
exit for
end if
end for
end if
' VIDEO CODECS
'
' AVC / h264 / MPEG4 AVC
2023-11-04 19:11:14 +00:00
for each container in transcodingContainers
if di.CanDecodeVideo({ Codec: "h264", Container: container }).Result
if container = "mp4"
' check for codec string before adding it
if mp4VideoCodecs.Instr(0, ",h264") = -1
mp4VideoCodecs = mp4VideoCodecs + ",h264"
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
else if container = "ts"
' check for codec string before adding it
if tsVideoCodecs.Instr(0, ",h264") = -1
tsVideoCodecs = tsVideoCodecs + ",h264"
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
end if
end if
if di.CanDecodeVideo({ Codec: "mpeg4 avc", Container: container }).Result
if container = "mp4"
' check for codec string before adding it
if mp4VideoCodecs.Instr(0, ",mpeg4 avc") = -1
mp4VideoCodecs = mp4VideoCodecs + ",mpeg4 avc"
end if
else if container = "ts"
' check for codec string before adding it
if tsVideoCodecs.Instr(0, ",mpeg4 avc") = -1
tsVideoCodecs = tsVideoCodecs + ",mpeg4 avc"
end if
end if
end if
2023-10-06 03:18:36 +00:00
end for
2023-11-04 19:11:14 +00:00
' HEVC / h265
if globalUserSettings["playback.compatibility.disablehevc"] = false
for each container in transcodingContainers
if di.CanDecodeVideo({ Codec: "hevc", Container: container }).Result
2023-10-06 03:18:36 +00:00
if container = "mp4"
' check for codec string before adding it
2023-11-04 19:11:14 +00:00
if mp4VideoCodecs.Instr(0, "h265,") = -1
mp4VideoCodecs = "h265," + mp4VideoCodecs
end if
if mp4VideoCodecs.Instr(0, "hevc,") = -1
mp4VideoCodecs = "hevc," + mp4VideoCodecs
2023-10-06 03:18:36 +00:00
end if
else if container = "ts"
' check for codec string before adding it
2023-11-04 19:11:14 +00:00
if tsVideoCodecs.Instr(0, "h265,") = -1
tsVideoCodecs = "h265," + tsVideoCodecs
end if
if tsVideoCodecs.Instr(0, "hevc,") = -1
tsVideoCodecs = "hevc," + tsVideoCodecs
2023-10-06 03:18:36 +00:00
end if
end if
end if
end for
2023-11-04 19:11:14 +00:00
end if
' VP9
for each container in transcodingContainers
if di.CanDecodeAudio({ Codec: "vp9", Container: container }).Result
if container = "mp4"
' check for codec string before adding it
if mp4VideoCodecs.Instr(0, ",vp9") = -1
mp4VideoCodecs = mp4VideoCodecs + ",vp9"
end if
else if container = "ts"
' check for codec string before adding it
if tsVideoCodecs.Instr(0, ",vp9") = -1
tsVideoCodecs = tsVideoCodecs + ",vp9"
end if
end if
end if
2023-10-06 03:18:36 +00:00
end for
' MPEG2
2023-11-04 19:11:14 +00:00
if globalUserSettings["playback.mpeg2"]
for each container in transcodingContainers
if di.CanDecodeVideo({ Codec: "mpeg2", Container: container }).Result
if container = "mp4"
' check for codec string before adding it
if mp4VideoCodecs.Instr(0, ",mpeg2video") = -1
mp4VideoCodecs = mp4VideoCodecs + ",mpeg2video"
end if
else if container = "ts"
' check for codec string before adding it
if tsVideoCodecs.Instr(0, ",mpeg2video") = -1
tsVideoCodecs = tsVideoCodecs + ",mpeg2video"
2023-10-06 03:18:36 +00:00
end if
end if
2023-11-04 19:11:14 +00:00
end if
2023-10-06 03:18:36 +00:00
end for
end if
' AV1
2023-11-04 19:11:14 +00:00
for each container in transcodingContainers
if di.CanDecodeVideo({ Codec: "av1", Container: container }).Result
if container = "mp4"
' check for codec string before adding it
if mp4VideoCodecs.Instr(0, ",av1") = -1
mp4VideoCodecs = mp4VideoCodecs + ",av1"
end if
else if container = "ts"
' check for codec string before adding it
if tsVideoCodecs.Instr(0, ",av1") = -1
tsVideoCodecs = tsVideoCodecs + ",av1"
end if
end if
end if
end for
2023-10-06 03:18:36 +00:00
' AUDIO CODECS
2023-11-04 19:11:14 +00:00
for each container in transcodingContainers
2023-10-06 03:18:36 +00:00
for each codec in audioCodecs
if di.CanDecodeAudio({ Codec: codec, Container: container }).result
if container = "mp4"
mp4AudioCodecs = mp4AudioCodecs + "," + codec
else if container = "ts"
tsAudioCodecs = tsAudioCodecs + "," + codec
end if
end if
end for
end for
2023-11-05 20:36:11 +00:00
' add aac to TranscodingProfile for stereo audio
' NOTE: multichannel aac is not supported. only decode to stereo on some devices
2023-11-04 19:11:14 +00:00
transcodingProfiles.push({
2023-11-05 20:36:11 +00:00
"Container": "aac",
2023-10-06 03:18:36 +00:00
"Type": "Audio",
2023-11-05 20:36:11 +00:00
"AudioCodec": "aac",
2023-10-06 03:18:36 +00:00
"Context": "Streaming",
"Protocol": "http",
2023-11-05 20:36:11 +00:00
"MaxAudioChannels": "2"
2023-10-06 03:18:36 +00:00
})
2023-11-04 19:11:14 +00:00
transcodingProfiles.push({
2023-11-05 20:36:11 +00:00
"Container": "aac",
2023-10-06 03:18:36 +00:00
"Type": "Audio",
2023-11-05 20:36:11 +00:00
"AudioCodec": "aac",
2023-10-06 03:18:36 +00:00
"Context": "Static",
"Protocol": "http",
2023-11-05 20:36:11 +00:00
"MaxAudioChannels": "2"
2023-10-06 03:18:36 +00:00
})
2023-11-05 20:36:11 +00:00
' add mp3 to TranscodingProfile for multichannel music
2023-11-04 19:11:14 +00:00
transcodingProfiles.push({
2023-11-05 20:36:11 +00:00
"Container": "mp3",
2023-10-06 03:18:36 +00:00
"Type": "Audio",
2023-11-05 20:36:11 +00:00
"AudioCodec": "mp3",
2023-10-06 03:18:36 +00:00
"Context": "Streaming",
"Protocol": "http",
2023-11-05 20:36:11 +00:00
"MaxAudioChannels": maxAudioChannels
2023-10-06 03:18:36 +00:00
})
2023-11-04 19:11:14 +00:00
transcodingProfiles.push({
2023-11-05 20:36:11 +00:00
"Container": "mp3",
2023-10-06 03:18:36 +00:00
"Type": "Audio",
2023-11-05 20:36:11 +00:00
"AudioCodec": "mp3",
2023-10-06 03:18:36 +00:00
"Context": "Static",
"Protocol": "http",
2023-11-05 20:36:11 +00:00
"MaxAudioChannels": maxAudioChannels
2023-10-06 03:18:36 +00:00
})
tsArray = {
"Container": "ts",
"Context": "Streaming",
"Protocol": "hls",
"Type": "Video",
"AudioCodec": tsAudioCodecs,
"VideoCodec": tsVideoCodecs,
"MaxAudioChannels": maxAudioChannels,
"MinSegments": 1,
"BreakOnNonKeyFrames": false
}
mp4Array = {
"Container": "mp4",
"Context": "Streaming",
"Protocol": "hls",
"Type": "Video",
"AudioCodec": mp4AudioCodecs,
"VideoCodec": mp4VideoCodecs,
"MaxAudioChannels": maxAudioChannels,
"MinSegments": 1,
"BreakOnNonKeyFrames": false
}
2023-11-04 19:11:14 +00:00
' apply max res to transcoding profile
if globalUserSettings["playback.resolution.max"] < > "off"
tsArray.Conditions = [getMaxHeightArray(), getMaxWidthArray()]
mp4Array.Conditions = [getMaxHeightArray(), getMaxWidthArray()]
end if
' surround sound
if surroundSoundCodec < > invalid
' add preferred surround sound codec to TranscodingProfile
transcodingProfiles.push({
"Container": surroundSoundCodec,
"Type": "Audio",
"AudioCodec": surroundSoundCodec,
"Context": "Streaming",
"Protocol": "http",
"MaxAudioChannels": maxAudioChannels
})
transcodingProfiles.push({
"Container": surroundSoundCodec,
"Type": "Audio",
"AudioCodec": surroundSoundCodec,
"Context": "Static",
"Protocol": "http",
"MaxAudioChannels": maxAudioChannels
})
' put codec in front of AudioCodec string
if tsArray.AudioCodec = ""
tsArray.AudioCodec = surroundSoundCodec
else
tsArray.AudioCodec = surroundSoundCodec + "," + tsArray.AudioCodec
end if
if mp4Array.AudioCodec = ""
mp4Array.AudioCodec = surroundSoundCodec
else
mp4Array.AudioCodec = surroundSoundCodec + "," + mp4Array.AudioCodec
end if
end if
transcodingProfiles.push(tsArray)
transcodingProfiles.push(mp4Array)
return transcodingProfiles
end function
function getContainerProfiles() as object
containerProfiles = []
return containerProfiles
end function
function getCodecProfiles() as object
globalUserSettings = m.global.session.user.settings
codecProfiles = []
profileSupport = {
"h264": {},
"mpeg4 avc": {},
"h265": {},
"hevc": {},
"vp9": {},
"mpeg2": {},
"av1": {}
}
maxResSetting = globalUserSettings["playback.resolution.max"]
di = CreateObject("roDeviceInfo")
maxHeightArray = getMaxHeightArray()
maxWidthArray = getMaxWidthArray()
' AUDIO
' test each codec to see how many channels are supported
audioCodecs = ["aac", "mp3", "mp2", "opus", "pcm", "lpcm", "wav", "flac", "alac", "ac3", "ac4", "aiff", "dts", "wmapro", "vorbis", "eac3", "mpg123"]
audioChannels = [8, 6, 2] ' highest first
for each audioCodec in audioCodecs
for each audioChannel in audioChannels
channelSupportFound = false
if di.CanDecodeAudio({ Codec: audioCodec, ChCnt: audioChannel }).Result
channelSupportFound = true
for each codecType in ["VideoAudio", "Audio"]
2023-11-05 20:36:11 +00:00
if audioCodec = "opus" and codecType = "Audio"
' opus audio files not supported by roku
else
codecProfiles.push({
"Type": codecType,
"Codec": audioCodec,
"Conditions": [
{
"Condition": "LessThanEqual",
"Property": "AudioChannels",
"Value": audioChannel,
"IsRequired": true
}
]
})
end if
2023-11-04 19:11:14 +00:00
end for
end if
if channelSupportFound
' if 8 channels are supported we don't need to test for 6 or 2
' if 6 channels are supported we don't need to test 2
exit for
end if
end for
end for
' check device for codec profile and level support
' AVC / h264 / MPEG4 AVC
h264Profiles = ["main", "high"]
h264Levels = ["4.1", "4.2"]
for each profile in h264Profiles
for each level in h264Levels
if di.CanDecodeVideo({ Codec: "h264", Profile: profile, Level: level }).Result
profileSupport = updateProfileArray(profileSupport, "h264", profile, level)
end if
if di.CanDecodeVideo({ Codec: "mpeg4 avc", Profile: profile, Level: level }).Result
profileSupport = updateProfileArray(profileSupport, "mpeg4 avc", profile, level)
end if
end for
end for
' HEVC / h265
hevcProfiles = ["main", "main 10"]
hevcLevels = ["4.1", "5.0", "5.1"]
for each profile in hevcProfiles
for each level in hevcLevels
if di.CanDecodeVideo({ Codec: "hevc", Profile: profile, Level: level }).Result
profileSupport = updateProfileArray(profileSupport, "h265", profile, level)
profileSupport = updateProfileArray(profileSupport, "hevc", profile, level)
end if
end for
end for
' VP9
vp9Profiles = ["profile 0", "profile 2"]
vp9Levels = ["4.1", "5.0", "5.1"]
for each profile in vp9Profiles
for each level in vp9Levels
if di.CanDecodeVideo({ Codec: "vp9", Profile: profile, Level: level }).Result
profileSupport = updateProfileArray(profileSupport, "vp9", profile, level)
end if
end for
end for
2023-10-06 03:18:36 +00:00
2023-11-04 19:11:14 +00:00
' MPEG2
' mpeg2 uses levels with no profiles. see https://developer.roku.com/en-ca/docs/references/brightscript/interfaces/ifdeviceinfo.md#candecodevideovideo_format-as-object-as-object
' NOTE: the mpeg2 levels are being saved in the profileSupport array as if they were profiles
mpeg2Levels = ["main", "high"]
for each level in mpeg2Levels
if di.CanDecodeVideo({ Codec: "mpeg2", Level: level }).Result
profileSupport = updateProfileArray(profileSupport, "mpeg2", level)
end if
end for
2023-10-06 03:18:36 +00:00
2023-11-04 19:11:14 +00:00
' AV1
av1Profiles = ["main", "main 10"]
av1Levels = ["4.1", "5.0", "5.1"]
for each profile in av1Profiles
for each level in av1Levels
if di.CanDecodeVideo({ Codec: "av1", Profile: profile, Level: level }).Result
profileSupport = updateProfileArray(profileSupport, "av1", profile, level)
end if
end for
end for
2023-10-06 03:18:36 +00:00
2023-11-04 19:11:14 +00:00
' HDR SUPPORT
h264VideoRangeTypes = "SDR"
hevcVideoRangeTypes = "SDR"
vp9VideoRangeTypes = "SDR"
av1VideoRangeTypes = "SDR"
2023-10-06 03:18:36 +00:00
2023-11-04 19:11:14 +00:00
dp = di.GetDisplayProperties()
if dp.Hdr10
hevcVideoRangeTypes = hevcVideoRangeTypes + "|HDR10"
vp9VideoRangeTypes = vp9VideoRangeTypes + "|HDR10"
av1VideoRangeTypes = av1VideoRangeTypes + "|HDR10"
end if
if dp.Hdr10Plus
av1VideoRangeTypes = av1VideoRangeTypes + "|HDR10+"
end if
if dp.HLG
hevcVideoRangeTypes = hevcVideoRangeTypes + "|HLG"
vp9VideoRangeTypes = vp9VideoRangeTypes + "|HLG"
av1VideoRangeTypes = av1VideoRangeTypes + "|HLG"
end if
if dp.DolbyVision
h264VideoRangeTypes = h264VideoRangeTypes + "|DOVI"
hevcVideoRangeTypes = hevcVideoRangeTypes + "|DOVI"
'vp9VideoRangeTypes = vp9VideoRangeTypes + ",DOVI" no evidence that vp9 can hold DOVI
av1VideoRangeTypes = av1VideoRangeTypes + "|DOVI"
end if
2023-10-06 03:18:36 +00:00
' H264
2023-11-04 19:11:14 +00:00
h264LevelSupported = 0.0
2023-10-06 03:18:36 +00:00
h264AssProfiles = {}
2023-11-04 19:11:14 +00:00
for each profile in profileSupport["h264"]
h264AssProfiles.AddReplace(profile, true)
for each level in profileSupport["h264"][profile]
levelFloat = level.ToFloat()
if levelFloat > h264LevelSupported
h264LevelSupported = levelFloat
end if
2023-10-06 03:18:36 +00:00
end for
end for
' convert to string
2023-11-04 19:11:14 +00:00
h264LevelString = h264LevelSupported.ToStr()
2023-10-06 03:18:36 +00:00
' remove decimals
h264LevelString = removeDecimals(h264LevelString)
2023-11-04 19:11:14 +00:00
h264ProfileArray = {
2023-10-06 03:18:36 +00:00
"Type": "Video",
"Codec": "h264",
"Conditions": [
{
"Condition": "NotEquals",
"Property": "IsAnamorphic",
"Value": "true",
"IsRequired": false
},
2023-11-04 19:11:14 +00:00
{
"Condition": "LessThanEqual",
"Property": "VideoBitDepth",
"Value": "8",
"IsRequired": false
},
2023-10-06 03:18:36 +00:00
{
"Condition": "EqualsAny",
"Property": "VideoProfile",
"Value": h264AssProfiles.Keys().join("|"),
"IsRequired": false
},
{
"Condition": "EqualsAny",
"Property": "VideoRangeType",
"Value": h264VideoRangeTypes,
"IsRequired": false
}
]
}
2023-11-04 19:11:14 +00:00
2023-10-06 03:18:36 +00:00
' check user setting before adding video level restrictions
2023-11-04 19:11:14 +00:00
if not globalUserSettings["playback.tryDirect.h264ProfileLevel"]
h264ProfileArray.Conditions.push({
2023-10-06 03:18:36 +00:00
"Condition": "LessThanEqual",
"Property": "VideoLevel",
"Value": h264LevelString,
"IsRequired": false
})
end if
2023-11-04 19:11:14 +00:00
' set max resolution
if globalUserSettings["playback.resolution.mode"] = "everything" and maxResSetting < > "off"
h264ProfileArray.Conditions.push(maxHeightArray)
h264ProfileArray.Conditions.push(maxWidthArray)
end if
2023-10-06 03:18:36 +00:00
' set bitrate restrictions based on user settings
bitRateArray = GetBitRateLimit("h264")
if bitRateArray.count() > 0
2023-11-04 19:11:14 +00:00
h264ProfileArray.Conditions.push(bitRateArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
codecProfiles.push(h264ProfileArray)
2023-10-06 03:18:36 +00:00
' MPEG2
' NOTE: the mpeg2 levels are being saved in the profileSupport array as if they were profiles
2023-11-04 19:11:14 +00:00
if globalUserSettings["playback.mpeg2"]
2023-10-06 03:18:36 +00:00
mpeg2Levels = []
2023-11-04 19:11:14 +00:00
for each level in profileSupport["mpeg2"]
if not arrayHasValue(mpeg2Levels, level)
mpeg2Levels.push(level)
end if
2023-10-06 03:18:36 +00:00
end for
2023-11-04 19:11:14 +00:00
mpeg2ProfileArray = {
2023-10-06 03:18:36 +00:00
"Type": "Video",
"Codec": "mpeg2",
"Conditions": [
{
"Condition": "EqualsAny",
"Property": "VideoLevel",
"Value": mpeg2Levels.join("|"),
"IsRequired": false
}
]
}
' set max resolution
2023-11-04 19:11:14 +00:00
if globalUserSettings["playback.resolution.mode"] = "everything" and maxResSetting < > "off"
mpeg2ProfileArray.Conditions.push(maxHeightArray)
mpeg2ProfileArray.Conditions.push(maxWidthArray)
2023-10-06 03:18:36 +00:00
end if
' set bitrate restrictions based on user settings
bitRateArray = GetBitRateLimit("mpeg2")
if bitRateArray.count() > 0
2023-11-04 19:11:14 +00:00
mpeg2ProfileArray.Conditions.push(bitRateArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
codecProfiles.push(mpeg2ProfileArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
if di.CanDecodeVideo({ Codec: "av1" }).Result
av1LevelSupported = 0.0
2023-10-27 02:20:25 +00:00
av1AssProfiles = {}
2023-11-04 19:11:14 +00:00
for each profile in profileSupport["av1"]
av1AssProfiles.AddReplace(profile, true)
for each level in profileSupport["av1"][profile]
levelFloat = level.ToFloat()
if levelFloat > av1LevelSupported
av1LevelSupported = levelFloat
end if
2023-10-06 03:18:36 +00:00
end for
end for
2023-11-04 19:11:14 +00:00
av1ProfileArray = {
2023-10-06 03:18:36 +00:00
"Type": "Video",
"Codec": "av1",
"Conditions": [
{
"Condition": "EqualsAny",
"Property": "VideoProfile",
"Value": av1AssProfiles.Keys().join("|"),
"IsRequired": false
},
{
"Condition": "EqualsAny",
"Property": "VideoRangeType",
"Value": av1VideoRangeTypes,
"IsRequired": false
},
{
"Condition": "LessThanEqual",
"Property": "VideoLevel",
2023-11-04 19:11:14 +00:00
"Value": (120 * av1LevelSupported).ToStr(),
2023-10-06 03:18:36 +00:00
"IsRequired": false
}
]
}
' set max resolution
2023-11-04 19:11:14 +00:00
if globalUserSettings["playback.resolution.mode"] = "everything" and maxResSetting < > "off"
av1ProfileArray.Conditions.push(maxHeightArray)
av1ProfileArray.Conditions.push(maxWidthArray)
2023-10-06 03:18:36 +00:00
end if
' set bitrate restrictions based on user settings
bitRateArray = GetBitRateLimit("av1")
if bitRateArray.count() > 0
2023-11-04 19:11:14 +00:00
av1ProfileArray.Conditions.push(bitRateArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
codecProfiles.push(av1ProfileArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
if not globalUserSettings["playback.compatibility.disablehevc"] and di.CanDecodeVideo({ Codec: "hevc" }).Result
hevcLevelSupported = 0.0
2023-10-06 03:18:36 +00:00
hevcAssProfiles = {}
2023-11-04 19:11:14 +00:00
for each profile in profileSupport["hevc"]
hevcAssProfiles.AddReplace(profile, true)
for each level in profileSupport["hevc"][profile]
levelFloat = level.ToFloat()
if levelFloat > hevcLevelSupported
hevcLevelSupported = levelFloat
end if
2023-10-06 03:18:36 +00:00
end for
end for
hevcLevelString = "120"
2023-11-04 19:11:14 +00:00
if hevcLevelSupported = 5.1
2023-10-06 03:18:36 +00:00
hevcLevelString = "153"
end if
2023-11-04 19:11:14 +00:00
hevcProfileArray = {
2023-10-06 03:18:36 +00:00
"Type": "Video",
"Codec": "hevc",
"Conditions": [
{
"Condition": "NotEquals",
"Property": "IsAnamorphic",
"Value": "true",
"IsRequired": false
},
{
"Condition": "EqualsAny",
"Property": "VideoProfile",
2023-11-04 19:11:14 +00:00
"Value": profileSupport["hevc"].Keys().join("|"),
2023-10-06 03:18:36 +00:00
"IsRequired": false
},
{
"Condition": "EqualsAny",
"Property": "VideoRangeType",
"Value": hevcVideoRangeTypes,
"IsRequired": false
}
]
}
' check user setting before adding VideoLevel restrictions
2023-11-04 19:11:14 +00:00
if not globalUserSettings["playback.tryDirect.hevcProfileLevel"]
hevcProfileArray.Conditions.push({
2023-10-06 03:18:36 +00:00
"Condition": "LessThanEqual",
"Property": "VideoLevel",
"Value": hevcLevelString,
"IsRequired": false
})
end if
2023-11-04 19:11:14 +00:00
' set max resolution
if globalUserSettings["playback.resolution.mode"] = "everything" and maxResSetting < > "off"
hevcProfileArray.Conditions.push(maxHeightArray)
hevcProfileArray.Conditions.push(maxWidthArray)
end if
2023-10-06 03:18:36 +00:00
' set bitrate restrictions based on user settings
bitRateArray = GetBitRateLimit("h265")
if bitRateArray.count() > 0
2023-11-04 19:11:14 +00:00
hevcProfileArray.Conditions.push(bitRateArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
codecProfiles.push(hevcProfileArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
if di.CanDecodeVideo({ Codec: "vp9" }).Result
2023-10-06 03:18:36 +00:00
vp9Profiles = []
2023-11-04 19:11:14 +00:00
vp9LevelSupported = 0.0
for each profile in profileSupport["vp9"]
vp9Profiles.push(profile)
for each level in profileSupport["vp9"][profile]
levelFloat = level.ToFloat()
if levelFloat > vp9LevelSupported
vp9LevelSupported = levelFloat
2023-10-06 03:18:36 +00:00
end if
end for
end for
2023-11-04 19:11:14 +00:00
vp9LevelString = "120"
if vp9LevelSupported = 5.1
vp9LevelString = "153"
end if
vp9ProfileArray = {
2023-10-06 03:18:36 +00:00
"Type": "Video",
"Codec": "vp9",
"Conditions": [
{
"Condition": "EqualsAny",
2023-11-04 19:11:14 +00:00
"Property": "VideoProfile",
2023-10-06 03:18:36 +00:00
"Value": vp9Profiles.join("|"),
"IsRequired": false
},
{
"Condition": "EqualsAny",
"Property": "VideoRangeType",
"Value": vp9VideoRangeTypes,
"IsRequired": false
2023-11-04 19:11:14 +00:00
},
{
"Condition": "LessThanEqual",
"Property": "VideoLevel",
"Value": vp9LevelString,
"IsRequired": false
2023-10-06 03:18:36 +00:00
}
]
}
' set max resolution
2023-11-04 19:11:14 +00:00
if globalUserSettings["playback.resolution.mode"] = "everything" and maxResSetting < > "off"
vp9ProfileArray.Conditions.push(maxHeightArray)
vp9ProfileArray.Conditions.push(maxWidthArray)
2023-10-06 03:18:36 +00:00
end if
' set bitrate restrictions based on user settings
bitRateArray = GetBitRateLimit("vp9")
if bitRateArray.count() > 0
2023-11-04 19:11:14 +00:00
vp9ProfileArray.Conditions.push(bitRateArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
codecProfiles.push(vp9ProfileArray)
2023-10-06 03:18:36 +00:00
end if
2023-11-04 19:11:14 +00:00
return codecProfiles
2023-10-06 03:18:36 +00:00
end function
2023-11-04 19:11:14 +00:00
function getSubtitleProfiles() as object
subtitleProfiles = []
2023-10-06 03:18:36 +00:00
2023-11-04 19:11:14 +00:00
subtitleProfiles.push({
"Format": "vtt",
"Method": "External"
})
subtitleProfiles.push({
"Format": "srt",
"Method": "External"
})
subtitleProfiles.push({
"Format": "ttml",
"Method": "External"
2023-10-06 03:18:36 +00:00
})
2023-11-04 19:11:14 +00:00
subtitleProfiles.push({
"Format": "sub",
"Method": "External"
})
return subtitleProfiles
2023-10-06 03:18:36 +00:00
end function
function GetBitRateLimit(codec as string) as object
2023-11-04 19:11:14 +00:00
globalUserSettings = m.global.session.user.settings
if globalUserSettings["playback.bitrate.maxlimited"]
userSetLimit = globalUserSettings["playback.bitrate.limit"].ToInt()
2023-10-06 03:18:36 +00:00
if isValid(userSetLimit) and type(userSetLimit) = "Integer" and userSetLimit > 0
userSetLimit *= 1000000
return {
"Condition": "LessThanEqual",
"Property": "VideoBitrate",
"Value": userSetLimit.ToStr(),
"IsRequired": true
}
else
codec = Lcase(codec)
' Some repeated values (e.g. same "40mbps" for several codecs)
' but this makes it easy to update in the future if the bitrates start to deviate.
if codec = "h264"
' Roku only supports h264 up to 10Mpbs
return {
"Condition": "LessThanEqual",
"Property": "VideoBitrate",
"Value": "10000000",
"IsRequired": true
}
else if codec = "av1"
' Roku only supports AV1 up to 40Mpbs
return {
"Condition": "LessThanEqual",
"Property": "VideoBitrate",
"Value": "40000000",
"IsRequired": true
}
else if codec = "h265"
' Roku only supports h265 up to 40Mpbs
return {
"Condition": "LessThanEqual",
"Property": "VideoBitrate",
"Value": "40000000",
"IsRequired": true
}
else if codec = "vp9"
' Roku only supports VP9 up to 40Mpbs
return {
"Condition": "LessThanEqual",
"Property": "VideoBitrate",
"Value": "40000000",
"IsRequired": true
}
end if
end if
end if
return {}
end function
2023-11-04 19:11:14 +00:00
function getMaxHeightArray() as object
myGlobal = m.global
maxResSetting = myGlobal.session.user.settings["playback.resolution.max"]
if maxResSetting = "off" then return {}
maxVideoHeight = maxResSetting
if maxResSetting = "auto"
maxVideoHeight = myGlobal.device.videoHeight
end if
return {
"Condition": "LessThanEqual",
"Property": "Height",
"Value": maxVideoHeight,
"IsRequired": true
}
end function
function getMaxWidthArray() as object
myGlobal = m.global
maxResSetting = myGlobal.session.user.settings["playback.resolution.max"]
if maxResSetting = "off" then return {}
maxVideoWidth = invalid
if maxResSetting = "auto"
maxVideoWidth = myGlobal.device.videoWidth
else if maxResSetting = "360"
maxVideoWidth = "480"
else if maxResSetting = "480"
maxVideoWidth = "640"
else if maxResSetting = "720"
maxVideoWidth = "1280"
else if maxResSetting = "1080"
maxVideoWidth = "1920"
else if maxResSetting = "2160"
maxVideoWidth = "3840"
else if maxResSetting = "4320"
maxVideoWidth = "7680"
end if
return {
"Condition": "LessThanEqual",
"Property": "Width",
"Value": maxVideoWidth,
"IsRequired": true
}
end function
2023-10-06 03:18:36 +00:00
' Recieves and returns an assArray of supported profiles and levels for each video codec
function updateProfileArray(profileArray as object, videoCodec as string, videoProfile as string, profileLevel = "" as string) as object
' validate params
if profileArray = invalid then return {}
if videoCodec = "" or videoProfile = "" then return profileArray
if profileArray[videoCodec] = invalid
profileArray[videoCodec] = {}
end if
if profileArray[videoCodec][videoProfile] = invalid
profileArray[videoCodec][videoProfile] = {}
end if
' add profileLevel if a value was provided
if profileLevel < > ""
if profileArray[videoCodec][videoProfile][profileLevel] = invalid
profileArray[videoCodec][videoProfile].AddReplace(profileLevel, true)
end if
end if
return profileArray
end function
' Remove all decimals from a string
function removeDecimals(value as string) as string
r = CreateObject("roRegex", "\.", "")
value = r.ReplaceAll(value, "")
return value
end function
2023-10-27 02:20:25 +00:00
' Takes and returns a comma delimited string of codecs.
' Moves the preferred codec to the front of the string
function setPreferredCodec(codecString as string, preferredCodec as string) as string
if preferredCodec = "" then return ""
if codecString = "" then return preferredCodec
preferredCodecSize = Len(preferredCodec)
' is the codec already in front?
if Left(codecString, preferredCodecSize) = preferredCodec
return codecString
else
' convert string to array
codecArray = codecString.Split(",")
' remove preferred codec from array
newArray = []
for each codec in codecArray
if codec < > preferredCodec
newArray.push(codec)
end if
end for
' convert newArray to string
newCodecString = newArray.Join(",")
' add preferred codec to front of newCodecString
newCodecString = preferredCodec + "," + newCodecString
return newCodecString
end if
end function
2023-10-27 02:19:51 +00:00
< / pre >
< / article >
< / section >
< / div >
< / div >
< div class = "clearfix" > < / div >
< / div >
< / div >
< div class = "modal fade" id = "searchResults" >
< div class = "modal-dialog" >
< div class = "modal-content" >
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" aria-label = "Close" > < span aria-hidden = "true" > × < / span > < / button >
< h4 class = "modal-title" > Search results< / h4 >
< / div >
< div class = "modal-body" > < / div >
< div class = "modal-footer" >
< button type = "button" class = "btn btn-default" data-dismiss = "modal" > Close< / button >
< / div >
< / div > <!-- /.modal - content -->
< / div > <!-- /.modal - dialog -->
< / div >
< footer >
< span class = "jsdoc-message" > Source code: < a href = "https://github.com/jellyfin/jellyfin-roku" > https://github.com/jellyfin/jellyfin-roku< / a > < / span > < span class = "jsdoc-message" > Jellyfin Roku Development Forum: < a href = "https://forum.jellyfin.org/f-roku-development" > https://forum.jellyfin.org/f-roku-development< / a > < / span >
< span class = "jsdoc-message" >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 4.0.2< / a >
2023-11-06 00:05:04 +00:00
on Nov 6th 2023
2023-10-27 02:19:51 +00:00
using the < a href = "https://github.com/docstrap/docstrap" > DocStrap template< / a > .
< / span >
< / footer >
< script src = "scripts/docstrap.lib.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script type = "text/javascript" src = "scripts/fulltext-search-ui.js" > < / script >
< script >
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang & & lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
< / script >
<!-- Navigation and Symbol Display -->
<!-- Google Analytics -->
< script type = "text/javascript" >
$(document).ready(function() {
SearcherDisplay.init();
});
< / script >
< / body >
< / html >
