com.wowza.wms.dvr

Interface IDvrStreamStore

public interface IDvrStreamStore

Method Summary

Methods

Modifier and Type	Method and Description
void	addDvrChunkListener(IDvrStoreChunkListener listener) Add (very fine) listener for chunk events.
void	addManifestEntries(java.util.List<DvrManifestEntry> entries)
boolean	canPlay() Is this store capable of playing.
boolean	canRecord() Is this store capable of recording.
IApplicationInstance	getAppInstance() Get associated application instance.
IDvrChunker	getChunker()
long	getClosestStartTime(int type, long t)
String	getContextStr() Get stream context string, useful for logging.
com.wowza.wms.dvr.DvrChunk	getDvrChunkAtTime(int fragmentType, long t)
com.wowza.wms.dvr.DvrChunk	getDvrChunkByIndex(int fragmentType, long index)
com.wowza.wms.dvr.DvrChunk	getDvrChunkNearTime(int fragmentType, long t, long delta)
IDvrStreamManager	getDvrManager() Get DVR Stream Manager
int	getDvrStorageWindowSeconds() Get DVR window size.
com.wowza.wms.dvr.io.IDvrFileSystem	getFileSystem()
IDvrManifest	getManifest() Get manifest
WMSProperties	getProperties() Get stream store properties.
IDvrPurgeController	getPurgeController() Get purge controller for stream store.
java.util.List<DvrManifestEntry>	getRecordedEntriesWithLimit(int fragmentType, long t, int limit)
DvrManifestEntry	getRecordedEntryByIndex(int fragmentType, long index)
DvrManifestEntry	getRecordedEntryByTime(int fragmentType, long t)
String	getStreamName() Get versioned stream name.
com.wowza.wms.dvr.DvrTimeMapper	getTimeMapper() Get time mapper, which maps between DVR, real and packet time.
boolean	hasAudio() Does this store have audio.
boolean	hasData() Does this store have data.
boolean	hasEncryption() Does this store contain encryption information
boolean	hasOnMetadata() Does this store have on metadata.
boolean	hasVideo() Does this store have video.
void	init() Initialize DVR stream store.
boolean	isLive() Is store currently live For an origin, isRecording() and isLive() will typically return the same result.
boolean	isLoaded()
boolean	isRecording() Is store currently recording.
boolean	isRecordingPaused() Is store currently paused while recording.
boolean	pauseRecording() Request that stream recording pause.
void	purgeEntries(DvrManifestEntryRangeGroup rangeGroup) Purge entries from store
void	removeDvrChunkListener(IDvrStoreChunkListener listener) Remove (very fine) listener for chunk events.
void	reset()
boolean	resumeRecording() Request that stream recording resume.
void	setCanPlay(boolean canPlay) Set the Stream Stores ability to play.
void	setCanRecord(boolean canRecord) Set the Stream Stores ability to record.
void	setHasEncryption(boolean hasEncryption) Set whether the store has encryption.
void	setReadCacheEnable(boolean enable) Set the state of the read cache
void	shutdown()
void	shutdownReadCache() Shutdown the read cache, this should get called when the store shuts down.
boolean	startRecording() Request that recording start.
boolean	stopRecording() Request that stream recording stop.
com.wowza.wms.dvr.DvrChunkStorageInfo	storeChunks(int vDuration, com.wowza.wms.dvr.DvrPacketHolder vPackets, int aDuration, com.wowza.wms.dvr.DvrPacketHolder aPackets, int dDuration, com.wowza.wms.dvr.DvrPacketHolder dPackets)
boolean	storeOnMetadata(long pt, long utc, AMFPacket metaPacket)

Method Detail

addDvrChunkListener

void addDvrChunkListener(IDvrStoreChunkListener listener)

Add (very fine) listener for chunk events.

Parameters:

listener - listener

addManifestEntries

void addManifestEntries(java.util.List<DvrManifestEntry> entries)

canPlay

boolean canPlay()

Is this store capable of playing.

Returns:

true if store can play

canRecord

boolean canRecord()

Is this store capable of recording.

Returns:

true if store can record

getAppInstance

IApplicationInstance getAppInstance()

Get associated application instance.

Returns:

application instance.

getChunker

IDvrChunker getChunker()

getClosestStartTime

long getClosestStartTime(int type,
                       long t)

getContextStr

String getContextStr()

Get stream context string, useful for logging.

Returns:

stream context string

getDvrChunkAtTime

com.wowza.wms.dvr.DvrChunk getDvrChunkAtTime(int fragmentType,
                                           long t)

getDvrChunkByIndex

com.wowza.wms.dvr.DvrChunk getDvrChunkByIndex(int fragmentType,
                                            long index)

getDvrChunkNearTime

com.wowza.wms.dvr.DvrChunk getDvrChunkNearTime(int fragmentType,
                                             long t,
                                             long delta)

getDvrManager

IDvrStreamManager getDvrManager()

Get DVR Stream Manager

Returns:

DVR Stream Manager

getDvrStorageWindowSeconds

int getDvrStorageWindowSeconds()

Get DVR window size. This may be set by setting the IDvrStreamStore's property IDvrConstants.PROPERTY_WINDOW_DURATION after the store is created and before it is initialized by using the IDvrStoreListener.dvrStreamStoreCreate(IDvrStreamStore)

Returns:

window size in seconds (0 means infinite window size)

getFileSystem

com.wowza.wms.dvr.io.IDvrFileSystem getFileSystem()

getManifest

IDvrManifest getManifest()

Get manifest

Returns:

manifest

getProperties

WMSProperties getProperties()

Get stream store properties.

Returns:

properties

getPurgeController

IDvrPurgeController getPurgeController()

Get purge controller for stream store.

Returns:

purge controller

getRecordedEntriesWithLimit

java.util.List<DvrManifestEntry> getRecordedEntriesWithLimit(int fragmentType,
                                                           long t,
                                                           int limit)

getRecordedEntryByIndex

DvrManifestEntry getRecordedEntryByIndex(int fragmentType,
                                       long index)

getRecordedEntryByTime

DvrManifestEntry getRecordedEntryByTime(int fragmentType,
                                      long t)

getStreamName

String getStreamName()

Get versioned stream name.

Returns:

(versioned) stream name

getTimeMapper

com.wowza.wms.dvr.DvrTimeMapper getTimeMapper()

Get time mapper, which maps between DVR, real and packet time.

Returns:

time mapper

hasAudio

boolean hasAudio()

Does this store have audio.

Returns:

true if store contains audio, false otherwise.

hasData

boolean hasData()

Does this store have data.

Returns:

true if store contains data, false otherwise.

hasEncryption

boolean hasEncryption()

Does this store contain encryption information

Returns:

true if store contains encryption

hasOnMetadata

boolean hasOnMetadata()

Does this store have on metadata.

Returns:

true if store contains on metadata, false otherwise.

hasVideo

boolean hasVideo()

Does this store have video.

Returns:

true if store contains video, false otherwise.

init

void init()

Initialize DVR stream store.

isLive

boolean isLive()

Is store currently live For an origin, isRecording() and isLive() will typically return the same result. On an origin, isRecording() will always be false. But isLive() will reflect the status of the repeated stream.

Returns:

true if live

isLoaded

boolean isLoaded()

isRecording

boolean isRecording()

Is store currently recording. This will always be false for an edge.

Returns:

true if recording

isRecordingPaused

boolean isRecordingPaused()

Is store currently paused while recording.

Returns:

true if recording is paused.

pauseRecording

boolean pauseRecording()

Request that stream recording pause.

Used internally. Clients should call ILiveStreamDvrRecorder.pauseRecording().

Success occurs if the stream is not already paused.

Returns:

true if successful.

purgeEntries

void purgeEntries(DvrManifestEntryRangeGroup rangeGroup)

Purge entries from store

Parameters:

rangeGroup - s set of ranges for purging

removeDvrChunkListener

void removeDvrChunkListener(IDvrStoreChunkListener listener)

Remove (very fine) listener for chunk events.

Parameters:

listener - listener

reset

void reset()

resumeRecording

boolean resumeRecording()

Request that stream recording resume.

Used internally. Clients should call ILiveStreamDvrRecorder.resumeRecording().

Success occurs if the stream was previously paused.

Returns:

true if successful.

setCanPlay

void setCanPlay(boolean canPlay)

Set the Stream Stores ability to play.

Note: Must be called when stream is not playing.

Parameters:

canPlay -

setCanRecord

void setCanRecord(boolean canRecord)

Set the Stream Stores ability to record.

Note: Must be called when stream is not recording.

Parameters:

canRecord -

setHasEncryption

void setHasEncryption(boolean hasEncryption)

Set whether the store has encryption. Used internally.

Note: Must be called when stream is not playing.

Parameters:

hasEncryption - if store has encryption

setReadCacheEnable

void setReadCacheEnable(boolean enable)

Set the state of the read cache

Parameters:

enable -

shutdown

void shutdown()

shutdownReadCache

void shutdownReadCache()

Shutdown the read cache, this should get called when the store shuts down.

startRecording

boolean startRecording()

Request that recording start.

Used internally. Clients should call ILiveStreamDvrRecorder.startRecording().

Success occurs if the stream canRecord canRecord() and the stream is not already in the recording state isRecording().

Returns:

true if successful.

stopRecording

boolean stopRecording()

Request that stream recording stop. This shuts down saving of chunks

Used internally. Clients should call ILiveStreamDvrRecorder.stopRecording().

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

Returns:

true if successful.

storeChunks

com.wowza.wms.dvr.DvrChunkStorageInfo storeChunks(int vDuration,
                                                com.wowza.wms.dvr.DvrPacketHolder vPackets,
                                                int aDuration,
                                                com.wowza.wms.dvr.DvrPacketHolder aPackets,
                                                int dDuration,
                                                com.wowza.wms.dvr.DvrPacketHolder dPackets)

storeOnMetadata

boolean storeOnMetadata(long pt,
                      long utc,
                      AMFPacket metaPacket)