Package com.wowza.wms.stream.livedvr

Interface ILiveStreamDvrRecorder

public interface ILiveStreamDvrRecorder

ILiveStreamDvrRecorder: DVR Recorder interface.

  • Method Details

    • init

      void init(String streamName, String recorderName, IApplicationInstance appInstance, com.wowza.wms.stream.livedvr.DvrRecorderItem dvrRecorderItem)
      Initialize DVR recorder.
      Parameters:
      streamName - stream name
      recorderName - DVR recorder name
      appInstance - application instance
      dvrRecorderItem - DVR recorder

    • shutdown

      void shutdown()
      Called to shutdown the DVR recorder

    • getStream

      IMediaStream getStream()
      Get the current stream that is being recorded
      Returns:
      stream

    • getAppInstance

      IApplicationInstance getAppInstance()
      Get associated applicationInstance.
      Returns:
      application Instance

    • handlePacket

      void handlePacket(IMediaStream stream, AMFPacket packet)
      Called to handle an incoming packet
      Parameters:
      stream - stream
      packet - packet

    • startStream

      void startStream(IMediaStream stream)
      Called when the stream starts
      Parameters:
      stream - stream

    • resetStream

      void resetStream(IMediaStream stream)
      Called when something happens that forces the stream to reset
      Parameters:
      stream - stream

    • touch

      void touch(long timecode)
      Touch the stream to keep it active
      Parameters:
      timecode - timecode of touch in milliseconds

    • isActive

      boolean isActive()
      Is the DVR recorder active
      Returns:
      true if active

    • getProperties

      WMSProperties getProperties()
      Get properties
      Returns:
      properties

    • getDvrRecorderId

      int getDvrRecorderId()
      Get the DVR recorder id
      Returns:
      DVR recorder id

    • setDvrRecorderId

      void setDvrRecorderId(int liveStreamId)
      Set the DVR recorder id
      Parameters:
      liveStreamId -

    • getDvrManager

      IDvrStreamManager getDvrManager()
      Get DVR recorder's associated DVR stream manager
      Returns:
      DVR manager

    • canRecordAudio

      boolean canRecordAudio()
      True if audio is being recorded
      Returns:
      True if audio is being recorded

    • setRecordAudio

      void setRecordAudio(boolean recordAudio)
      Set to true to record audio
      Parameters:
      recordAudio - true to record audio

    • canRecordVideo

      boolean canRecordVideo()
      True if video is being recorded
      Returns:
      True if video is being recorded

    • setRecordVideo

      void setRecordVideo(boolean recordVideo)
      Set to true to record video
      Parameters:
      recordVideo - true to record video

    • canRecordData

      boolean canRecordData()
      True if data is being recorded
      Returns:
      True if data is being recorded

    • setRecordData

      void setRecordData(boolean recordVideo)
      Set to true to record data
      Parameters:
      recordVideo - true to record data

    • startRecording

      IDvrStreamManager startRecording()
      Request that stream recording start.
      Returns:
      stream manager if successful. null otherwise.

    • isRecording

      boolean isRecording()
      Is this stream currently recording. If this stream is not recordable, the method returns false.
      Returns:
      true if has a recording stream and it is recording.

    • isRecordingPaused

      boolean isRecordingPaused()
      Is this stream currently paused from recording. If this stream is not recording and not paused, the method returns false.
      Returns:
      true if has a recording is paused.

    • stopRecording

      boolean stopRecording()
      Request that stream recording stop. Note that this call places the DVR stream in the not recording state.

      A successful stop will result in registered IDvrRecordingListeners to have their IDvrRecordingListener.recordingStopped(IDvrStreamStore) method called.

      Success only occurs if the stream is already in the recording state IDvrStreamStore.isRecording().

      Returns:
      store if successful. null otherwise.

    • pauseRecording

      boolean pauseRecording()
      Request that stream recording pause. The stream does not have to be actively recording to be paused. For example, it could be paused before packets start flowing.

      A successful pause will result in registered IDvrRecordingListeners to have their IDvrRecordingListener.recordingPaused(IDvrStreamStore) method called.

      Returns:
      store if successful. null otherwise.

    • resumeRecording

      boolean resumeRecording()
      Request that stream recording resume. The stream does not have to be actively recording to be resumed. For example, it could have been paused before the stream started, and this call would move it out of the paused state.

      A successful resume will result in registered IDvrRecordingListeners to have their IDvrRecordingListener.recordingResumed(IDvrStreamStore) method called.

      Returns:
      store if successful. null otherwise.

    • setRecordingName

      void setRecordingName(String name)

    • getRecordingName

      String getRecordingName()

    • shouldStartRecordingOnStartup

      boolean shouldStartRecordingOnStartup()
      Should DVR start recording when packets start flowing.
      Returns:
      true if should start recording initially, false otherwise

    • setStartRecordingOnStartup

      void setStartRecordingOnStartup(boolean shouldStartRecordingOnStartup)
      Set recording behavior of DVR Manager on startup.
      Parameters:
      shouldStartRecordingOnStartup - should recording start when DVR manager starts.

    • getLicenseHolder

      com.wowza.wms.client.LicenseHolder getLicenseHolder()

    • getAndSetStartStream

      IMediaStream getAndSetStartStream(IMediaStream stream)