t

mythtv.connection.myth

MythProtocolAPI

trait MythProtocolAPI extends AnyRef

A strongly-typed, thin API wrapper over the MythProtocol commands.

Linear Supertypes
AnyRef, Any
Known Subclasses
MythProtocolAPIConnection, MythProtocolApi75, MythProtocolApi77, MythProtocolApi88, MythProtocolApi91
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MythProtocolAPI
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def allowShutdown(): MythProtocolResult[Boolean]
  2. abstract def announce(mode: String, hostName: String = "", eventMode: MythProtocolEventMode = MythProtocolEventMode.None): MythProtocolResult[Boolean]
  3. abstract def announceFileTransfer(hostName: String, fileName: String, storageGroup: String, writeMode: Boolean = false, useReadAhead: Boolean = false, timeout: Duration = Duration.ofSeconds(2), checkFiles: Seq[String] = Nil): MythProtocolResult[(FileTransferId, ByteCount, Seq[String])]
  4. abstract def announceSlaveBackend(slaveHostName: String, slaveIpAddr: InetAddress, currentlyRecording: Seq[Recording]): MythProtocolResult[Boolean]
  5. abstract def backendMessage(message: String, extra: String*): MythProtocolResult[Boolean]
  6. abstract def blockShutdown(): MythProtocolResult[Boolean]
  7. abstract def checkRecording(rec: Recording): MythProtocolResult[Boolean]
  8. abstract def deleteFile(fileName: String, storageGroup: String): MythProtocolResult[Boolean]
  9. abstract def deleteRecording(chanId: ChanId, startTime: MythDateTime, forceDeleteMetadata: Boolean = false, forgetHistory: Boolean = false): MythProtocolResult[Int]
  10. abstract def deleteRecording(chanId: ChanId, startTime: MythDateTime): MythProtocolResult[Int]
  11. abstract def deleteRecording(rec: Recording): MythProtocolResult[Int]
  12. abstract def done(): Unit
  13. abstract def downloadFile(sourceUrl: URI, storageGroup: String, fileName: String = ""): MythProtocolResult[URI]
  14. abstract def downloadFileNow(sourceUrl: URI, storageGroup: String, fileName: String = ""): MythProtocolResult[URI]
  15. abstract def fillProgramInfo(playbackHost: String, p: Recording): MythProtocolResult[Recording]
  16. abstract def forceDeleteRecording(rec: Recording): MythProtocolResult[Int]
  17. abstract def forgetRecording(rec: Recording): MythProtocolResult[Boolean]
  18. abstract def freeTuner(cardId: CaptureCardId): MythProtocolResult[Boolean]
  19. abstract def getFreeInputInfo(excludedInput: InputId): MythProtocolResult[List[Input]]
  20. abstract def getFreeInputInfo: MythProtocolResult[List[Input]]
  21. abstract def getRecorderFromNum(cardId: CaptureCardId): MythProtocolResult[RemoteEncoder]
  22. abstract def getRecorderNum(rec: Recording): MythProtocolResult[RemoteEncoder]
  23. abstract def goToSleep(): MythProtocolResult[Boolean]
  24. abstract def lockTuner(cardId: CaptureCardId): MythProtocolResult[Tuner]
  25. abstract def lockTuner(): MythProtocolResult[Tuner]
  26. abstract def message(message: String, extra: String*): MythProtocolResult[Boolean]
  27. abstract def messageSetLogLevel(logLevel: MythLogLevel): MythProtocolResult[Boolean]
  28. abstract def messageSetVerbose(verboseMask: String): MythProtocolResult[Boolean]
  29. abstract def protocolVersion(ver: Int, token: String): MythProtocolResult[(Boolean, Int)]
  30. abstract def queryActiveBackends: MythProtocolResult[List[String]]
  31. abstract def queryBookmark(chanId: ChanId, startTime: MythDateTime): MythProtocolResult[VideoPositionFrame]
  32. abstract def queryCheckFile(rec: Recording, checkSlaves: Boolean = true): MythProtocolResult[String]
  33. abstract def queryCommBreak(chanId: ChanId, startTime: MythDateTime): MythProtocolResult[List[VideoSegmentFrames]]
  34. abstract def queryCutList(chanId: ChanId, startTime: MythDateTime): MythProtocolResult[List[VideoSegmentFrames]]
  35. abstract def queryFileExists(fileName: String, storageGroup: String = ""): MythProtocolResult[(String, FileStats)]
  36. abstract def queryFileHash(fileName: String, storageGroup: String, hostName: String = ""): MythProtocolResult[MythFileHash]
  37. abstract def queryFileTransferDone(ftId: FileTransferId): Unit
  38. abstract def queryFileTransferIsOpen(ftId: FileTransferId): MythProtocolResult[Boolean]
  39. abstract def queryFileTransferReopen(ftId: FileTransferId, newFileName: String): MythProtocolResult[Boolean]
  40. abstract def queryFileTransferRequestBlock(ftId: FileTransferId, blockSize: Int): MythProtocolResult[Int]
  41. abstract def queryFileTransferRequestSize(ftId: FileTransferId): MythProtocolResult[Long]
  42. abstract def queryFileTransferSeek(ftId: FileTransferId, pos: Long, whence: SeekWhence, currentPos: Long): MythProtocolResult[Long]
  43. abstract def queryFileTransferSetTimeout(ftId: FileTransferId, fast: Boolean): Unit
  44. abstract def queryFileTransferWriteBlock(ftId: FileTransferId, blockSize: Int): MythProtocolResult[Int]
  45. abstract def queryFreeSpace: MythProtocolResult[List[FreeSpace]]
  46. abstract def queryFreeSpaceList: MythProtocolResult[List[FreeSpace]]
  47. abstract def queryFreeSpaceSummary: MythProtocolResult[(ByteCount, ByteCount)]
  48. abstract def queryGenPixmap(rec: Recording, token: String = "", time: VideoPosition = VideoPositionSeconds(-1), outputFile: String = "", width: Int = 0, height: Int = 0): MythProtocolResult[Boolean]
  49. abstract def queryGetAllPending: MythProtocolResult[ExpectedCountIterator[Recordable]]
  50. abstract def queryGetAllScheduled: MythProtocolResult[ExpectedCountIterator[Recordable]]
  51. abstract def queryGetConflicting(rec: Recording): MythProtocolResult[ExpectedCountIterator[Recording]]
  52. abstract def queryGetExpiring: MythProtocolResult[ExpectedCountIterator[Recording]]
  53. abstract def queryGuideDataThrough: MythProtocolResult[MythDateTime]
  54. abstract def queryHostname: MythProtocolResult[String]
  55. abstract def queryIsActiveBackend(hostName: String): MythProtocolResult[Boolean]
  56. abstract def queryIsRecording: MythProtocolResult[(Int, Int)]
  57. abstract def queryLoad: MythProtocolResult[(Double, Double, Double)]
  58. abstract def queryMemStats: MythProtocolResult[(ByteCount, ByteCount, ByteCount, ByteCount)]
  59. abstract def queryPixmapGetIfModified(modifiedSince: MythDateTime, maxFileSize: Long, rec: Recording): MythProtocolResult[(MythDateTime, Option[PixmapInfo])]
  60. abstract def queryPixmapGetIfModified(maxFileSize: Long, rec: Recording): MythProtocolResult[(MythDateTime, Option[PixmapInfo])]
  61. abstract def queryPixmapLastModified(rec: Recording): MythProtocolResult[MythDateTime]
  62. abstract def queryRecorderCancelNextRecording(cardId: CaptureCardId, cancel: Boolean): MythProtocolResult[Unit]
  63. abstract def queryRecorderChangeBrightness(cardId: CaptureCardId, adjType: PictureAdjustType, up: Boolean): MythProtocolResult[Int]
  64. abstract def queryRecorderChangeChannel(cardId: CaptureCardId, dir: ChannelChangeDirection): MythProtocolResult[Unit]
  65. abstract def queryRecorderChangeColour(cardId: CaptureCardId, adjType: PictureAdjustType, up: Boolean): MythProtocolResult[Int]
  66. abstract def queryRecorderChangeContrast(cardId: CaptureCardId, adjType: PictureAdjustType, up: Boolean): MythProtocolResult[Int]
  67. abstract def queryRecorderChangeHue(cardId: CaptureCardId, adjType: PictureAdjustType, up: Boolean): MythProtocolResult[Int]
  68. abstract def queryRecorderCheckChannel(cardId: CaptureCardId, channum: ChannelNumber): MythProtocolResult[Boolean]
  69. abstract def queryRecorderCheckChannelPrefix(cardId: CaptureCardId, channumPrefix: ChannelNumber): MythProtocolResult[(Boolean, Option[CaptureCardId], Boolean, String)]
  70. abstract def queryRecorderFillPositionMap(cardId: CaptureCardId, start: VideoPositionFrame, end: VideoPositionFrame): MythProtocolResult[Map[VideoPositionFrame, Long]]
  71. abstract def queryRecorderFinishRecording(cardId: CaptureCardId): MythProtocolResult[Unit]
  72. abstract def queryRecorderFrontendReady(cardId: CaptureCardId): MythProtocolResult[Unit]
  73. abstract def queryRecorderGetBrightness(cardId: CaptureCardId): MythProtocolResult[Int]
  74. abstract def queryRecorderGetChannelInfo(cardId: CaptureCardId, chanId: ChanId): MythProtocolResult[Channel]
  75. abstract def queryRecorderGetColour(cardId: CaptureCardId): MythProtocolResult[Int]
  76. abstract def queryRecorderGetContrast(cardId: CaptureCardId): MythProtocolResult[Int]
  77. abstract def queryRecorderGetCurrentRecording(cardId: CaptureCardId): MythProtocolResult[Recording]
  78. abstract def queryRecorderGetFilePosition(cardId: CaptureCardId): MythProtocolResult[Long]
  79. abstract def queryRecorderGetFrameRate(cardId: CaptureCardId): MythProtocolResult[Double]
  80. abstract def queryRecorderGetFramesWritten(cardId: CaptureCardId): MythProtocolResult[Long]
  81. abstract def queryRecorderGetFreeInputs(cardId: CaptureCardId, excludedCards: CaptureCardId*): MythProtocolResult[List[CardInput]]
  82. abstract def queryRecorderGetHue(cardId: CaptureCardId): MythProtocolResult[Int]
  83. abstract def queryRecorderGetInput(cardId: CaptureCardId): MythProtocolResult[String]
  84. abstract def queryRecorderGetKeyframePos(cardId: CaptureCardId, desiredPos: VideoPositionFrame): MythProtocolResult[Long]
  85. abstract def queryRecorderGetMaxBitrate(cardId: CaptureCardId): MythProtocolResult[Long]
  86. abstract def queryRecorderGetNextProgramInfo(cardId: CaptureCardId, channum: ChannelNumber, dir: ChannelBrowseDirection, startTime: MythDateTime): MythProtocolResult[UpcomingProgram]
  87. abstract def queryRecorderGetNextProgramInfo(cardId: CaptureCardId, chanId: ChanId, dir: ChannelBrowseDirection, startTime: MythDateTime): MythProtocolResult[UpcomingProgram]
  88. abstract def queryRecorderGetRecording(cardId: CaptureCardId): MythProtocolResult[Recording]
  89. abstract def queryRecorderIsRecording(cardId: CaptureCardId): MythProtocolResult[Boolean]
  90. abstract def queryRecorderPause(cardId: CaptureCardId): MythProtocolResult[Unit]
  91. abstract def queryRecorderSetChannel(cardId: CaptureCardId, channum: ChannelNumber): MythProtocolResult[Unit]
  92. abstract def queryRecorderSetInput(cardId: CaptureCardId, inputName: String): MythProtocolResult[String]
  93. abstract def queryRecorderSetLiveRecording(cardId: CaptureCardId, recordingState: Int): MythProtocolResult[Unit]
  94. abstract def queryRecorderSetSignalMonitoringRate(cardId: CaptureCardId, rate: Int, notifyFrontend: Boolean): MythProtocolResult[Boolean]
  95. abstract def queryRecorderShouldSwitchCard(cardId: CaptureCardId, chanId: ChanId): MythProtocolResult[Boolean]
  96. abstract def queryRecorderSpawnLiveTV(cardId: CaptureCardId, usePiP: Boolean, channumStart: ChannelNumber): MythProtocolResult[Unit]
  97. abstract def queryRecorderStopLiveTV(cardId: CaptureCardId): MythProtocolResult[Unit]
  98. abstract def queryRecorderToggleChannelFavorite(cardId: CaptureCardId, channelGroup: String): MythProtocolResult[Unit]
  99. abstract def queryRecording(chanId: ChanId, startTime: MythDateTime): MythProtocolResult[Recording]
  100. abstract def queryRecording(pathName: String): MythProtocolResult[Recording]
  101. abstract def queryRecordings(specifier: String = "Unsorted"): MythProtocolResult[ExpectedCountIterator[Recording]]
  102. abstract def queryRemoteEncoderCancelNextRecording(cardId: CaptureCardId, cancel: Boolean): MythProtocolResult[Unit]
  103. abstract def queryRemoteEncoderGetCurrentRecording(cardId: CaptureCardId): MythProtocolResult[Recording]
  104. abstract def queryRemoteEncoderGetFlags(cardId: CaptureCardId): MythProtocolResult[Int]
  105. abstract def queryRemoteEncoderGetFreeInputs(cardId: CaptureCardId, excludedCards: CaptureCardId*): MythProtocolResult[List[CardInput]]
  106. abstract def queryRemoteEncoderGetMaxBitrate(cardId: CaptureCardId): MythProtocolResult[Long]
  107. abstract def queryRemoteEncoderGetRecordingStatus(cardId: CaptureCardId): MythProtocolResult[RecStatus]
  108. abstract def queryRemoteEncoderGetSleepStatus(cardId: CaptureCardId): MythProtocolResult[SleepStatus]
  109. abstract def queryRemoteEncoderGetState(cardId: CaptureCardId): MythProtocolResult[TvState]
  110. abstract def queryRemoteEncoderIsBusy(cardId: CaptureCardId, timeBufferSeconds: Int): MythProtocolResult[(Boolean, Option[CardInput], Option[ChanId])]
  111. abstract def queryRemoteEncoderIsBusy(cardId: CaptureCardId): MythProtocolResult[(Boolean, Option[CardInput], Option[ChanId])]
  112. abstract def queryRemoteEncoderMatchesRecording(cardId: CaptureCardId, rec: Recording): MythProtocolResult[Boolean]
  113. abstract def queryRemoteEncoderRecordPending(cardId: CaptureCardId, secondsLeft: Int, hasLaterShowing: Boolean, rec: Recording): MythProtocolResult[Unit]
  114. abstract def queryRemoteEncoderStartRecording(cardId: CaptureCardId, rec: Recording): MythProtocolResult[RecStatus]
  115. abstract def queryRemoteEncoderStopRecording(cardId: CaptureCardId): MythProtocolResult[Unit]
  116. abstract def querySGFileQuery(hostName: String, storageGroup: String, fileName: String): MythProtocolResult[(String, MythDateTime, ByteCount)]
  117. abstract def querySGGetFileList(hostName: String, storageGroup: String, path: String, fileNamesOnly: Boolean): MythProtocolResult[List[StorageGroupInfo]]
  118. abstract def querySGGetFileList(hostName: String, storageGroup: String, path: String): MythProtocolResult[List[StorageGroupInfo]]
  119. abstract def querySetting(hostName: String, settingName: String): MythProtocolResult[String]
  120. abstract def queryTimeZone: MythProtocolResult[TimeZoneInfo]
  121. abstract def queryUptime: MythProtocolResult[Duration]
  122. abstract def refreshBackend: MythProtocolResult[Boolean]
  123. abstract def rescheduleRecordingsCheck(recStatus: RecStatus = RecStatus.Unknown, recordId: RecordRuleId = RecordRuleId(0), findId: Int = 0, title: String = "", subtitle: String = "", description: String = "", programId: String = "", reason: String = "Scala"): MythProtocolResult[Boolean]
  124. abstract def rescheduleRecordingsMatch(recordId: RecordRuleId = RecordRuleId(0), sourceId: ListingSourceId = ListingSourceId(0), mplexId: MultiplexId = MultiplexId(0), maxStartTime: Option[MythDateTime] = None, reason: String = "Scala"): MythProtocolResult[Boolean]
  125. abstract def rescheduleRecordingsPlace(reason: String = "Scala"): MythProtocolResult[Boolean]
  126. abstract def scanVideos(): MythProtocolResult[Boolean]
  127. abstract def setBookmark(chanId: ChanId, startTime: MythDateTime, pos: VideoPositionFrame): MythProtocolResult[Boolean]
  128. abstract def setChannelInfo(chanId: ChanId, sourceId: ListingSourceId, oldChanNum: ChannelNumber, callsign: String, channum: ChannelNumber, name: String, xmltvId: String): MythProtocolResult[Boolean]
  129. abstract def setSetting(hostName: String, settingName: String, value: String): MythProtocolResult[Boolean]
  130. abstract def shutdownNow(haltCommand: String): Unit
  131. abstract def stopRecording(rec: Recording): MythProtocolResult[CaptureCardId]
  132. abstract def undeleteRecording(chanId: ChanId, startTime: MythDateTime): MythProtocolResult[Boolean]
  133. abstract def undeleteRecording(rec: Recording): MythProtocolResult[Boolean]
  134. abstract def getFreeRecorder: MythProtocolResult[RemoteEncoder]
    Annotations
    @deprecated
    Deprecated

    (Since version MythTV 0.28) use getFreeInputInfo

  135. abstract def getFreeRecorderCount: MythProtocolResult[Int]
    Annotations
    @deprecated
    Deprecated

    (Since version MythTV 0.28) use getFreeInputInfo

  136. abstract def getFreeRecorderList: MythProtocolResult[List[CaptureCardId]]
    Annotations
    @deprecated
    Deprecated

    (Since version MythTV 0.28) use getFreeInputInfo

  137. abstract def getNextFreeRecorder(cardId: CaptureCardId): MythProtocolResult[RemoteEncoder]
    Annotations
    @deprecated
    Deprecated

    (Since version MythTV 0.28) use getFreeInputInfo

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped