Package com.wowza.wms.vhost

Interface IVHost

public interface IVHost

IVHost: public interface to VHost object.

  • Field Details

    • VHOST_DEFAULT

      static final String VHOST_DEFAULT
      See Also:

    • VHOST_DEFAULT_HTTP_PERSISTENT

      static final boolean VHOST_DEFAULT_HTTP_PERSISTENT
      See Also:

    • LICENSECOUNTER_PUBLISHER

      static final int LICENSECOUNTER_PUBLISHER
      See Also:

    • LICENSECOUNTER_TRANSCODE_DECODE

      static final int LICENSECOUNTER_TRANSCODE_DECODE
      See Also:

    • LICENSECOUNTER_TRANSCODE_ENCODE

      static final int LICENSECOUNTER_TRANSCODE_ENCODE
      See Also:

    • LICENSECOUNTER_NDVR

      static final int LICENSECOUNTER_NDVR
      See Also:

    • LICENSECOUNTER_DRM_EZDRM_LIVE

      static final int LICENSECOUNTER_DRM_EZDRM_LIVE
      See Also:

    • LICENSECOUNTER_DRM_EZDRM_VOD

      static final int LICENSECOUNTER_DRM_EZDRM_VOD
      See Also:

    • LICENSECOUNTER_DRM_VERIMATRIX_LIVE

      static final int LICENSECOUNTER_DRM_VERIMATRIX_LIVE
      See Also:

    • LICENSECOUNTER_DRM_VERIMATRIX_VOD

      static final int LICENSECOUNTER_DRM_VERIMATRIX_VOD
      See Also:

    • LICENSECOUNTER_PUBLISHERTRANSCODER

      static final int LICENSECOUNTER_PUBLISHERTRANSCODER
      See Also:

    • LICENSECOUNTER_DRM_BUYDRM_LIVE

      static final int LICENSECOUNTER_DRM_BUYDRM_LIVE
      See Also:

    • LICENSECOUNTER_DRM_BUYDRM_VOD

      static final int LICENSECOUNTER_DRM_BUYDRM_VOD
      See Also:

    • LICENSECOUNTER_TRANSCODE_DECODEPOLLING

      static final int LICENSECOUNTER_TRANSCODE_DECODEPOLLING
      See Also:

    • LICENSECOUNTER_TRANSCODE_ENCODEPOLLING

      static final int LICENSECOUNTER_TRANSCODE_ENCODEPOLLING
      See Also:

    • LICENSECOUNTER_TRANSCODE_STREAMNAMES

      static final int LICENSECOUNTER_TRANSCODE_STREAMNAMES
      See Also:

    • LICENSECOUNTER_TRANSCODE_DECODECOUNTAUDIO

      static final int LICENSECOUNTER_TRANSCODE_DECODECOUNTAUDIO
      See Also:

    • LICENSECOUNTER_TRANSCODE_DECODECOUNTVIDEO

      static final int LICENSECOUNTER_TRANSCODE_DECODECOUNTVIDEO
      See Also:

    • LICENSECOUNTER_TRANSCODE_DECODECOUNTAUDIOVIDEO

      static final int LICENSECOUNTER_TRANSCODE_DECODECOUNTAUDIOVIDEO
      See Also:

    • LICENSECOUNTER_TRANSCODE_ENCODECOUNTAUDIO

      static final int LICENSECOUNTER_TRANSCODE_ENCODECOUNTAUDIO
      See Also:

    • LICENSECOUNTER_TRANSCODE_ENCODECOUNTVIDEO

      static final int LICENSECOUNTER_TRANSCODE_ENCODECOUNTVIDEO
      See Also:

    • LICENSECOUNTER_TRANSCODE_ENCODECOUNTAUDIOVIDEO

      static final int LICENSECOUNTER_TRANSCODE_ENCODECOUNTAUDIOVIDEO
      See Also:

    • LICENSECOUNTER_TOTAL

      static final int LICENSECOUNTER_TOTAL
      See Also:

    • LICENSECOUNTERS_DRM

      static final int[] LICENSECOUNTERS_DRM

    • COUNTER_RTMP

      static final int COUNTER_RTMP
      See Also:

    • COUNTER_RTP

      static final int COUNTER_RTP
      See Also:

    • COUNTER_HTTPCUPERTINO

      static final int COUNTER_HTTPCUPERTINO
      See Also:

    • COUNTER_HTTPSMOOTH

      static final int COUNTER_HTTPSMOOTH
      See Also:

    • COUNTER_HTTPSANJOSE

      static final int COUNTER_HTTPSANJOSE
      See Also:

    • COUNTER_HTTPWEBM

      static final int COUNTER_HTTPWEBM
      See Also:

    • COUNTER_HTTPMPEGDASH

      static final int COUNTER_HTTPMPEGDASH
      See Also:

    • COUNTER_HTTPDVRCHUNKS

      static final int COUNTER_HTTPDVRCHUNKS
      See Also:

    • COUNTER_HTTPTS

      static final int COUNTER_HTTPTS
      See Also:

    • COUNTER_WEBRTC

      static final int COUNTER_WEBRTC
      See Also:

    • COUNTER_TOTAL

      static final int COUNTER_TOTAL
      See Also:

    • CODEC_VIDEO_UNKNOWN

      static final int CODEC_VIDEO_UNKNOWN
      See Also:

    • CODEC_VIDEO_SPARK

      static final int CODEC_VIDEO_SPARK
      See Also:

    • CODEC_VIDEO_SCREEN

      static final int CODEC_VIDEO_SCREEN
      See Also:

    • CODEC_VIDEO_VP6

      static final int CODEC_VIDEO_VP6
      See Also:

    • CODEC_VIDEO_VP6A

      static final int CODEC_VIDEO_VP6A
      See Also:

    • CODEC_VIDEO_SCREEN2

      static final int CODEC_VIDEO_SCREEN2
      See Also:

    • CODEC_VIDEO_H264

      static final int CODEC_VIDEO_H264
      See Also:

    • CODEC_VIDEO_VPX

      static final int CODEC_VIDEO_VPX
      See Also:

    • CODEC_VIDEO_VP8

      static final int CODEC_VIDEO_VP8
      See Also:

    • CODEC_VIDEO_H263

      static final int CODEC_VIDEO_H263
      See Also:

    • CODEC_VIDEO_MPEG4

      static final int CODEC_VIDEO_MPEG4
      See Also:

    • CODEC_VIDEO_MPEG2

      static final int CODEC_VIDEO_MPEG2
      See Also:

    • CODEC_VIDEO_H265

      static final int CODEC_VIDEO_H265
      See Also:

    • CODEC_VIDEO_VERSION_DEFAULT

      static final int CODEC_VIDEO_VERSION_DEFAULT
      See Also:

    • CODEC_VIDEO_VERSION_VPX_VP8

      static final int CODEC_VIDEO_VERSION_VPX_VP8
      See Also:

    • CODEC_VIDEO_VERSION_VPX_VP9

      static final int CODEC_VIDEO_VERSION_VPX_VP9
      See Also:

    • CODEC_AUDIO_UNKNOWN

      static final int CODEC_AUDIO_UNKNOWN
      See Also:

    • CODEC_AUDIO_PCM_BE

      static final int CODEC_AUDIO_PCM_BE
      See Also:

    • CODEC_AUDIO_PCM_SWF

      static final int CODEC_AUDIO_PCM_SWF
      See Also:

    • CODEC_AUDIO_AC3

      static final int CODEC_AUDIO_AC3
      See Also:

    • CODEC_AUDIO_MP3

      static final int CODEC_AUDIO_MP3
      See Also:

    • CODEC_AUDIO_PCM_LE

      static final int CODEC_AUDIO_PCM_LE
      See Also:

    • CODEC_AUDIO_NELLYMOSER_16MONO

      static final int CODEC_AUDIO_NELLYMOSER_16MONO
      See Also:

    • CODEC_AUDIO_NELLYMOSER_8MONO

      static final int CODEC_AUDIO_NELLYMOSER_8MONO
      See Also:

    • CODEC_AUDIO_NELLYMOSER

      static final int CODEC_AUDIO_NELLYMOSER
      See Also:

    • CODEC_AUDIO_G711_ALAW

      static final int CODEC_AUDIO_G711_ALAW
      See Also:

    • CODEC_AUDIO_G711_MULAW

      static final int CODEC_AUDIO_G711_MULAW
      See Also:

    • CODEC_AUDIO_RESERVED

      static final int CODEC_AUDIO_RESERVED
      See Also:

    • CODEC_AUDIO_VORBIS

      static final int CODEC_AUDIO_VORBIS
      See Also:

    • CODEC_AUDIO_AAC

      static final int CODEC_AUDIO_AAC
      See Also:

    • CODEC_AUDIO_SPEEX

      static final int CODEC_AUDIO_SPEEX
      See Also:

    • CODEC_AUDIO_OPUS

      static final int CODEC_AUDIO_OPUS
      See Also:

    • CODEC_AUDIO_ALS

      static final int CODEC_AUDIO_ALS
      See Also:

    • CODEC_AUDIO_MP3_8

      static final int CODEC_AUDIO_MP3_8
      See Also:

    • CODEC_STREAM_UNKNOWN

      static final int CODEC_STREAM_UNKNOWN
      See Also:

    • CODEC_STREAM_MP2T

      static final int CODEC_STREAM_MP2T
      See Also:

    • FILEFORMAT_UNKNOWN

      static final int FILEFORMAT_UNKNOWN
      See Also:

    • FILEFORMAT_FLV

      static final int FILEFORMAT_FLV
      See Also:

    • FILEFORMAT_MP4

      static final int FILEFORMAT_MP4
      See Also:

    • CONTENTTYPE_UKNOWN

      static final byte CONTENTTYPE_UKNOWN
      AMF Content type: unknown
      See Also:

    • CONTENTTYPE_SETCHUNKSIZE

      static final byte CONTENTTYPE_SETCHUNKSIZE
      AMF Content type: set packet chunk size
      See Also:

    • CONTENTTYPE_WATCHDOG

      static final byte CONTENTTYPE_WATCHDOG
      AMF Content type: watch dog
      See Also:

    • CONTENTTYPE_BUFFERSIZE

      static final byte CONTENTTYPE_BUFFERSIZE
      AMF Content type: set buffer size
      See Also:

    • CONTENTTYPE_ACKBANDWIDTH

      static final byte CONTENTTYPE_ACKBANDWIDTH
      AMF Content type: set acknowledge bandwidth size
      See Also:

    • CONTENTTYPE_SETBANDWIDTH

      static final byte CONTENTTYPE_SETBANDWIDTH
      AMF Content type: set bandwidth size
      See Also:

    • CONTENTTYPE_AUDIO

      static final byte CONTENTTYPE_AUDIO
      AMF Content type: audio packet
      See Also:

    • CONTENTTYPE_VIDEO

      static final byte CONTENTTYPE_VIDEO
      AMF Content type: video packet
      See Also:

    • CONTENTTYPE_DATA

      static final byte CONTENTTYPE_DATA
      AMF Content type: data packet
      See Also:

    • CONTENTTYPE_DATA0

      static final byte CONTENTTYPE_DATA0
      AMF Content type: data packet (AMF0)
      See Also:

    • CONTENTTYPE_DATA3

      static final byte CONTENTTYPE_DATA3
      AMF Content type: data packet (AMF3)
      See Also:

    • CONTENTTYPE_SHAREDOBJECTS

      static final byte CONTENTTYPE_SHAREDOBJECTS
      AMF Content type: shared object packet (AMF0)
      See Also:

    • CONTENTTYPE_SHAREDOBJECTS0

      static final byte CONTENTTYPE_SHAREDOBJECTS0
      AMF Content type: shared object packet (AMF0)
      See Also:

    • CONTENTTYPE_SHAREDOBJECTS3

      static final byte CONTENTTYPE_SHAREDOBJECTS3
      AMF Content type: shared object packet (AMF3)
      See Also:

    • CONTENTTYPE_FUNCTION

      static final byte CONTENTTYPE_FUNCTION
      AMF Content type: function data (AMF0)
      See Also:

    • CONTENTTYPE_FUNCTION0

      static final byte CONTENTTYPE_FUNCTION0
      AMF Content type: function data (AMF0)
      See Also:

    • CONTENTTYPE_MEDIACHUNK

      static final byte CONTENTTYPE_MEDIACHUNK
      AMF Content type: media chunk
      See Also:

    • CONTENTTYPE_FUNCTION3

      static final byte CONTENTTYPE_FUNCTION3
      AMF Content type: function data (AMF3)
      See Also:

    • CONTENTTYPE_PLAYCALLBACK

      static final byte CONTENTTYPE_PLAYCALLBACK
      AMF Content type: play callback
      See Also:

    • ACCEPTORS_ACCEPTOR

      static final String ACCEPTORS_ACCEPTOR
      Acceptor types: acceptor
      See Also:

    • ACCEPTORS_HANDLERADAPTER

      static final String ACCEPTORS_HANDLERADAPTER
      Acceptor types: handler
      See Also:

    • DEFAULT_WEBRTC_IDLEFREQUENCY

      static final int DEFAULT_WEBRTC_IDLEFREQUENCY
      See Also:

  • Method Details

    • init

      void init(String basePath)
      Initialize vHost.
      Parameters:
      basePath - base path to configuration files

    • shutdown

      void shutdown()
      Shutdown.

    • getStreamTypes

      StreamList getStreamTypes()
      Get default stream type.
      Returns:
      default stream type

    • getProperty

      String getProperty(String key)
      Get virtual host property.
      Parameters:
      key - key
      Returns:
      property value or null if does not exist

    • getClientTimeout

      int getClientTimeout()
      Get client timeout.
      Returns:
      client timeout

    • getNextNetConnectionId

      int getNextNetConnectionId()
      Get next connection id.
      Returns:
      next connection id

    • getClient

      IClient getClient(int clientId)
      Get client by client id.
      Parameters:
      clientId - client id
      Returns:
      client

    • getClient

      IClient getClient(int clientId, boolean create)
      Get client by client id and create if does not exist.
      Parameters:
      clientId - client id
      create - create if does not exist
      Returns:
      client

    • removeClient

      void removeClient(int clientId)
      Remove client from vHost.
      Parameters:
      clientId - client id

    • stopClient

      void stopClient(int clientId)
      Remove client from vHost and send disconnect message.
      Parameters:
      clientId - client id

    • stopRTSPSession

      void stopRTSPSession(String rtspSessionId)
      Stop an RTSP connection by the RTSP session id
      Parameters:
      rtspSessionId - RTSP session id

    • getApplication

      IApplication getApplication(String applicationName)
      Get application by name. Loads application if it's not loaded already If you are going to immediately start an application instance you should call
      Parameters:
      applicationName - application name
      Returns:
      application
      See Also:

    • getApplication

      IApplication getApplication(String applicationName, boolean doLoad)
      Get application by name. May load application if it's not loaded already If you are going to immediately start an application instance you should call
      Parameters:
      applicationName - application name
      doLoad - when true will load application if it's not loaded already
      Returns:
      application
      See Also:

    • isApplicationLoaded

      boolean isApplicationLoaded(String applicationName)
      Return true is the application is loaded
      Parameters:
      applicationName - application name
      Returns:
      true if application is loaded

    • getHomePath

      String getHomePath()
      Get vHost configuration path.
      Returns:
      configuration path

    • getProperties

      WMSProperties getProperties()
      Get properties attached to this vHost.
      Returns:
      properties attached to this vHost

    • getManagerProperties

      WMSProperties getManagerProperties()
      Get VHost's manager's properties collection
      Returns:
      manager's property collection

    • getCoreTransportPoolSize

      int getCoreTransportPoolSize()
      Get the transport core thread pool size.
      Returns:
      default core thread pool size

    • setCoreTransportPoolSize

      void setCoreTransportPoolSize(int corePoolSize)
      Set the transport core thread pool size.
      Parameters:
      corePoolSize - core thread pool size

    • getCoreHandlerPoolSize

      int getCoreHandlerPoolSize()
      Get the handler core thread pool size.
      Returns:
      default core thread pool size

    • setCoreHandlerPoolSize

      void setCoreHandlerPoolSize(int corePoolSize)
      Set the handler core thread pool size.
      Parameters:
      corePoolSize - core thread pool size

    • getFileIOPoolSize

      int getFileIOPoolSize()
      Get the default file io pool size.
      Returns:
      default file io pool size

    • setFileIOPoolSize

      void setFileIOPoolSize(int fileIOPoolSize)
      Set default file io thread pool size.
      Parameters:
      fileIOPoolSize - default file io thread pool size

    • setClientTimeout

      void setClientTimeout(int clientTimeout)
      Set client timeout. An inactive client connected by RTMPT protocol will be deleted after this timeout.
      Parameters:
      clientTimeout - client timeout

    • getHostPortsList

      HostPortList getHostPortsList()
      Get list of host port definitions for vHost.
      Returns:
      list of host port definitions for vHost

    • getThreadPool

      ThreadPool getThreadPool()
      Get the VHost handler thread pool. Same as getHandlerThreadPool.
      Returns:
      VHost handler thread pool

    • getTransportThreadPool

      ThreadPool getTransportThreadPool()
      Get the VHost transport thread pool. This thread pool is used to read/write data from the transports sockets.
      Returns:
      VHost transport thread pool

    • getHandlerThreadPool

      ThreadPool getHandlerThreadPool()
      Get the VHost handler thread pool. This thread pool is used to process the incoming events.
      Returns:
      VHost handler thread pool

    • getName

      String getName()
      Get vHost name
      Returns:
      vHost name

    • setAdminInterfaceHostPort

      void setAdminInterfaceHostPort(HostPort adminInterfaceHostPort)
      Set admin interface host port (not used)
      Parameters:
      adminInterfaceHostPort - admin interface host port

    • getClientCount

      int getClientCount()
      Get number of clients connected to this vHost.
      Returns:
      number of clients connected to this vHost

    • getNetConnectionProcessorCount

      int getNetConnectionProcessorCount()
      Get net connection processor count. Number of threads used for server to server communication (not finished).
      Returns:
      net connection processor count

    • setNetConnectionProcessorCount

      void setNetConnectionProcessorCount(int netConnectionProcessorCount)
      Set net connection processor count. Number of threads used for server to server communication (not finished).
      Parameters:
      netConnectionProcessorCount - net connection processor count

    • addApplicationListener

      void addApplicationListener(IApplicationNotify applicationListener)
      Add application listener. An application listener will receive the following events: onApplicationCreate, onApplicationDestroy.
      Parameters:
      applicationListener - application listener

    • removeApplicationListener

      void removeApplicationListener(IApplicationNotify applicationListener)
      Remove applation listener.
      Parameters:
      applicationListener - applation listener

    • addAcceptorListener

      void addAcceptorListener(IAcceptorNotify acceptorListener)
      Add acceptor listener. Acceptor listeners will receive the following events: onAcceptorCreate, onAcceptorDestroy.
      Parameters:
      acceptorListener - acceptor listener

    • removeAcceptorListener

      void removeAcceptorListener(IAcceptorNotify acceptorListener)
      Remove acceptor listener.
      Parameters:
      acceptorListener - acceptor listener

    • getIOScheduler

      com.wowza.io.IOScheduler getIOScheduler()
      Get IO scheduler for vHost. IO scheduler is used to schedule reads from the disk to increase server throughput for static flv serving.
      Returns:
      IO scheduler for vHost

    • getIoPerformanceCounter

      IOPerformanceCounter getIoPerformanceCounter()
      Get vHost IO performance counter.
      Returns:
      io performance counter

    • getIoPerformanceCounter

      IOPerformanceCounter getIoPerformanceCounter(int counterIndex)
      Get vHost IO performance counter for a specific technology (see IVHost.COUNTER_*)
      Parameters:
      counterIndex - counter index (see IVHost.COUNTER_*)
      Returns:
      io performance counter

    • getConnectionCounter

      ConnectionCounter getConnectionCounter()
      Get vHost connection counter.
      Returns:
      connection counter

    • getConnectionCounter

      com.wowza.wms.client.ConnectionCounterSimple getConnectionCounter(int counterIndex)
      Get vHost connection counter for a specific technology (see IVHost.COUNTER_*)
      Parameters:
      counterIndex - counter index (see IVHost.COUNTER_*)
      Returns:
      connection counter

    • getDateStarted

      String getDateStarted()
      Get date and time the server was started.
      Returns:
      date and time the server was started

    • getTimeRunning

      String getTimeRunning()
      Get the time vHost has been running.
      Returns:
      formatted string with vHost uptime

    • getTimeRunningSeconds

      double getTimeRunningSeconds()
      Get time running in seconds
      Returns:
      time running in seconds

    • getConnectionLimit

      int getConnectionLimit()
      Get vHost connection limit.
      Returns:
      vHost connection limit

    • getMediaReaders

      com.wowza.wms.stream.MediaReaderList getMediaReaders()
      Get the media readers attached to vHost (MediaReaders.xml).
      Returns:
      media readers attached to vHost

    • getMediaWriters

      com.wowza.wms.stream.MediaWriterList getMediaWriters()
      Get the media writers attached to vHost (MediaWriters.xml).
      Returns:
      media writers attached to vHost

    • getMp3TagMap

      Map getMp3TagMap()
      Get MP3 tag map attached to vHost (MP3Tags.xml).
      Returns:
      MP3 tag map attached to vHost

    • getMp4TagMap

      Map getMp4TagMap()
      Get MP4 tag map attached to vHost (MP4Tags.xml).
      Returns:
      MP4 tag map attached to vHost

    • getCEACaptionConversionContext

      com.wowza.wms.timedtext.cea608.CEACaptionConversionContext getCEACaptionConversionContext()
      Get CEAConversionContextMP3 tag map attached to vHost (CEACaptionConversion.xml).
      Returns:
      MP3 tag map attached to vHost

    • updateLoggingDuration

      void updateLoggingDuration()
      Internal: update the internal logging values.

    • getApplicationTimeout

      int getApplicationTimeout()
      Get application time out (milliseconds). Time from last client disconnect to application destruction.
      Returns:
      application time out (milliseconds)

    • setApplicationTimeout

      void setApplicationTimeout(int applicationTimeout)
      Set application time out (milliseconds).
      Parameters:
      applicationTimeout - application time out (milliseconds)

    • getPingTimeout

      int getPingTimeout()
      Get ping timeout (milliseconds)
      Returns:
      ping timeout (milliseconds)

    • setPingTimeout

      void setPingTimeout(int pingTimeout)
      Set ping timeout (millseconds)
      Parameters:
      pingTimeout - ping timeout (millseconds)

    • getValidationFrequency

      int getValidationFrequency()
      Get time between validation pings (milliseconds)
      Returns:
      time between validation pings (milliseconds)

    • setValidationFrequency

      void setValidationFrequency(int validationFrequency)
      Set time between validation pings (milliseconds)
      Parameters:
      validationFrequency - time between validation pings (milliseconds)

    • getMaximumPendingWriteBytes

      int getMaximumPendingWriteBytes()
      Get maximum number a bytes a client connection can have waiting to be sent before the connection is terminated. If set to zero this feature is turned off.
      Returns:
      maximum number a bytes a client connection can have waiting to be sent before the connection is terminated

    • setMaximumPendingWriteBytes

      void setMaximumPendingWriteBytes(int maximumPendingWriteBytes)
      Set maximum number a bytes a client connection can have waiting to be sent before the connection is terminated. If set to zero this feature is turned off.
      Parameters:
      maximumPendingWriteBytes - maximum number a bytes a client connection can have waiting to be sent before the connection is terminated

    • getMaximumPendingReadBytes

      int getMaximumPendingReadBytes()
      Set maximum number of bytes a client connection can have waiting to be written before the connection is terminated. If set to zero this feature is off.
      Returns:
      maximum number of bytes a client connection can have waiting to be written before the connection is terminated

    • setMaximumPendingReadBytes

      void setMaximumPendingReadBytes(int maximumPendingReaderBytes)
      Get maximum number of bytes a client connection can have waiting to be written before the connection is terminated. If set to zero this feature is off.
      Parameters:
      maximumPendingReaderBytes - maximum number of bytes a client connection can have waiting to be written before the connection is terminated

    • getMaximumSetBufferTime

      int getMaximumSetBufferTime()
      Get maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call. If set to zero this feature is turned off.
      Returns:
      maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call

    • setMaximumSetBufferTime

      void setMaximumSetBufferTime(int maximumSetBufferTime)
      Set maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call. If set to zero this feature is turned off.
      Parameters:
      maximumSetBufferTime - maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call

    • getApplicationLock

      edu.emory.mathcs.backport.java.util.concurrent.locks.WMSReadWriteLock getApplicationLock()
      Get the object used in synchronized statements to lock and application.
      Returns:
      object used in synchronized statements to lock and application

    • getClientIdleFrequency

      int getClientIdleFrequency()
      Get default client idle frequency (milliseconds)
      Returns:
      default client idle frequency (milliseconds)

    • setClientIdleFrequency

      void setClientIdleFrequency(int clientIdleFrequency)
      Set default client idle frequency (milliseconds)
      Parameters:
      clientIdleFrequency - default client idle frequency (milliseconds)

    • getRTPIdleFrequency

      int getRTPIdleFrequency()
      Get default RTP idle frequency (milliseconds)
      Returns:
      default RTP idle frequency (milliseconds)

    • setRTPIdleFrequency

      void setRTPIdleFrequency(int rtpIdleFrequency)
      Set default RTP idle frequency (milliseconds)
      Parameters:
      rtpIdleFrequency - RTP default client idle frequency (milliseconds)

    • getWebRTCIdleFrequency

      int getWebRTCIdleFrequency()
      Get default WebRTC idle frequency (milliseconds)
      Returns:
      default WebRTC idle frequency (milliseconds)

    • setWebRTCIdleFrequency

      void setWebRTCIdleFrequency(int webrtcIdleFrequency)
      Set default WebRTC idle frequency (milliseconds)
      Parameters:
      webrtcIdleFrequency - default WebRTC idle frequency (milliseconds)

    • getNetConnectionIdleFrequency

      int getNetConnectionIdleFrequency()
      Get server to server idle frequency (milliseconds)
      Returns:
      server to server idle frequency (milliseconds)

    • setNetConnectionIdleFrequency

      void setNetConnectionIdleFrequency(int netConnectionIdleFrequency)
      Set the server to server idle frequency (milliseconds)
      Parameters:
      netConnectionIdleFrequency - server to server idle frequency (milliseconds)

    • getIdleCheckFrequency

      int getIdleCheckFrequency()
      Get idle check frequency (milliseconds)
      Returns:
      idle check frequency (milliseconds)

    • setIdleCheckFrequency

      void setIdleCheckFrequency(int idleCheckFrequency)
      Set idle check frequency (milliseconds)
      Parameters:
      idleCheckFrequency - idle check frequency (milliseconds)

    • getIdleWorkerCount

      int getIdleWorkerCount()
      Get number of threads used to generate idle events
      Returns:
      number of threads used to generate idle events

    • setIdleWorkerCount

      void setIdleWorkerCount(int idleWorkerCount)
      Set number of threads used to generate idle events
      Parameters:
      idleWorkerCount - number of threads used to generate idle events

    • getKeepAliveTimeout

      int getKeepAliveTimeout()
      Get the RTMPT connection keep alive timeout
      Returns:
      RTMPT connection keep alive timeout

    • setKeepAliveTimeout

      void setKeepAliveTimeout(int keepAliveTimeout)
      Set the RTMPT connection keep alive timeout
      Parameters:
      keepAliveTimeout - RTMPT connection keep alive timeout

    • addIdleWorkerListener

      void addIdleWorkerListener(com.wowza.wms.util.IIdleWorkerNotify idleWorkerListener)
      Add idleWorker listener. An idleWorker listener will receive the following events: onIdleWorkerCreate, onIdleWorkerDestroy.
      Parameters:
      idleWorkerListener - idleWorker listener

    • removeIdleWorkerListener

      void removeIdleWorkerListener(com.wowza.wms.util.IIdleWorkerNotify idleWorkerListener)
      Remove idleWorker listener
      Parameters:
      idleWorkerListener - idleWorker listener

    • getNetConnectionHostPortConfig

      HostPortConfig getNetConnectionHostPortConfig()
      Get the socket configuration for server to server connections
      Returns:
      socket configuration for server to server connections

    • getMediaCasterSettings

      MediaCasterSettings getMediaCasterSettings()
      Get the media caster settings
      Returns:
      media caster settings

    • getMediaCasterList

      MediaCasterList getMediaCasterList()
      Get the list of media caster definitions (MediaCaster.xml)
      Returns:
      list of media caster definitions

    • getApplicationNames

      List getApplicationNames()
      Get a list of application names
      Returns:
      list of application names

    • getApplicationFolderNames

      List getApplicationFolderNames()
      Get a list of application folder names
      Returns:
      list of application folder names

    • applicationExists

      boolean applicationExists(String name)
      Return true if an application folder exists for this application name
      Parameters:
      name - application name
      Returns:
      true if an application folder exists for this application name

    • getRTPContext

      RTPContext getRTPContext()
      Get the RTP (real time protocol) virtual host context
      Returns:
      RTP (real time protocol) virtual host context

    • getWebRTCContext

      com.wowza.wms.webrtc.model.WebRTCContext getWebRTCContext()
      Get the WebRTC virtual host context
      Returns:
      WebRTC virtual host context

    • getHTTPStreamerContext

      com.wowza.wms.httpstreamer.model.HTTPStreamerContext getHTTPStreamerContext()
      Get the HTTPStreamer (Cupertino Streaming and Silverlight Smooth Streaming) host context
      Returns:
      HTTPStreamer (Cupertino Streaming and Silverlight Smooth Streaming) host context

    • getRTPDatagramConfigIncoming

      com.wowza.wms.rtp.transport.RTPUDPDatagramConfig getRTPDatagramConfigIncoming()
      Get the RTP Datagram Socket configuration
      Returns:
      RTP Datagram Socket configuration

    • getRTPDatagramConfigOutgoing

      com.wowza.wms.rtp.transport.RTPUDPDatagramConfig getRTPDatagramConfigOutgoing()
      Get the RTP Datagram Socket configuration
      Returns:
      RTP Datagram Socket configuration

    • getAuthenticationList

      com.wowza.wms.authentication.AuthenticationList getAuthenticationList()
      Get the list of available authentication methods
      Returns:
      list of available authentication methods

    • getIdleMinimumWaitTime

      int getIdleMinimumWaitTime()
      Get the minimum time (milliseconds) the idle worker thread will sleep before generating idle events
      Returns:
      minimum time (milliseconds) the idle worker thread will sleep before generating idle events

    • setIdleMinimumWaitTime

      void setIdleMinimumWaitTime(int idleMinimumWaitTime)
      Set the minimum time (milliseconds) the idle worker thread will sleep before generating idle events
      Parameters:
      idleMinimumWaitTime - minimum time (milliseconds) the idle worker thread will sleep before generating idle events

    • getIdleWorkers

      com.wowza.wms.util.IdleWorkersUtil getIdleWorkers()
      Get the idle worker utility
      Returns:
      idle worker utility

    • isShuttingDown

      boolean isShuttingDown()
      Is the VHost shutting down
      Returns:
      true if the vhost is shutting down

    • setShuttingDown

      void setShuttingDown(boolean shuttingDown)
      Set VHost shutting down flag
      Parameters:
      shuttingDown - true if the vhost is shutting down

    • reparentClient

      void reparentClient(IClient client)
      Move a client object to a new vhost. This can only be done right after the handshake process has completed. See IVHostNotify.onVHostClientConnect.
      Parameters:
      client - client object to move

    • getDynamicLogProperties

      Properties getDynamicLogProperties()
      Get the dynamic log properties defined at the vhost level in conf/log4j.properties
      Returns:
      dynamic log properties defined at the vhost level

    • setDynamicLogProperties

      void setDynamicLogProperties(Properties dynamicLogProperties)
      Set the dynamic log properties set at the vhost level
      Parameters:
      dynamicLogProperties - dynamic log properties defined at the vhost level

    • shutdownApplication

      void shutdownApplication(String appName)
      Shutdown an application by name. This will disconnect all clients connected to all child application instances.
      Parameters:
      appName - application name

    • shutdownApplication

      void shutdownApplication(String appName, boolean deleteFolder)
      Shutdown an application by name. This will disconnect all clients connected to all child application instances.
      Parameters:
      appName - application name
      deleteFolder - delete the application folder

    • unbindAllHostPorts

      void unbindAllHostPorts()
      Unbind all HostPorts and drop all connections

    • suspendAllHostPorts

      void suspendAllHostPorts()
      Suspend all HostPorts from accepting new connections. Current connections will continue to be serviced

    • closeHostPort

      void closeHostPort(HostPort hostPort, boolean isSuspend)
      Close an individual HostPort
      Parameters:
      hostPort - host port to close
      isSuspend - if true will just suspend the HostPort from accepting new connections, if false will unbind and drop all connections

    • isSuspended

      boolean isSuspended()
      Returns true is all HostPorts connected to this VHost are suspended

    • touchApplicationInstance

      boolean touchApplicationInstance(String appName)
      Start an application instance if it is not already started then touch it so it stays loaded for at least 3 seconds.
      Parameters:
      appName - application name
      Returns:
      true is successful

    • touchApplicationInstance

      boolean touchApplicationInstance(String appName, String appInstanceName)
      Start an application instance if it is not already started then touch it so it stays loaded for at least 3 seconds. The default appInstanceName _definst_ will be used.
      Parameters:
      appName - application name
      appInstanceName - app instance name
      Returns:
      true is successful

    • getApplicationInstance

      IApplicationInstance getApplicationInstance(String appName, String appInstanceName)
      Gets an application instance for an application. This will create the application and application instance if it was not already created.
      Parameters:
      appName - application name or _defapp_ if not supplied
      appInstanceName - application instance name or _definst_ if not supplied
      Returns:
      created application instance unless the application name does not map to an application in which case returns null

    • getApplicationInstance

      IApplicationInstance getApplicationInstance(String appName, String appInstanceName, boolean doLoad)
      Gets an application instance for an application.
      Parameters:
      appName - application name or _defapp_ if not supplied
      appInstanceName - application instance name or _definst_ if not supplied
      doLoad - if false, will not create the application or application instance.
      Returns:
      created application instance unless the application name does not map to an application in which case returns null

    • startApplicationInstance

      boolean startApplicationInstance(String appName)
      Start an application instance. The default appInstanceName _definst_ will be used.
      Parameters:
      appName - application name
      Returns:
      true is successful

    • startApplicationInstance

      boolean startApplicationInstance(String appName, String appInstanceName)
      Start an application instance.
      Parameters:
      appName - application name
      appInstanceName - app instance name
      Returns:
      true is successful

    • getUDPTransportManager

      com.wowza.wms.rtp.transport.UDPTransportManager getUDPTransportManager()
      Get the UDP transport manager.
      Returns:
      UDP transport manager

    • getHTTPStreamerList

      com.wowza.wms.httpstreamer.model.HTTPStreamerList getHTTPStreamerList()
      Get the list of HTTPStreamers
      Returns:
      list of HTTPStreamers

    • getHTTPStreamerAdapter

      IHTTPStreamerAdapter getHTTPStreamerAdapter(String ID)
      Get an HTTPStreamerAdapter by ID
      Parameters:
      ID - HTTPStreamerAdapter ID
      Returns:
      HTTPStreamerAdapter

    • putHTTPStreamerAdapter

      void putHTTPStreamerAdapter(String ID, IHTTPStreamerAdapter adapter)
      Add an HTTPStreamerAdapter
      Parameters:
      ID - HTTPStreamerAdapter ID
      adapter - HTTPStreamerAdapter

    • getHTTPStreamerAdapterIDs

      List<String> getHTTPStreamerAdapterIDs()
      Get a list of HTTPStreamerAdapter IDs
      Returns:
      list of HTTPStreamerAdapter IDs

    • getLiveStreamPacketizerList

      com.wowza.wms.stream.livepacketizer.LiveStreamPacketizerList getLiveStreamPacketizerList()
      Get the LiveStreamPacketizerList
      Returns:
      LiveStreamPacketizerList

    • getLiveStreamTranscoderList

      com.wowza.wms.stream.livetranscoder.LiveStreamTranscoderList getLiveStreamTranscoderList()
      Get the LiveStreamTranscoderList
      Returns:
      LiveStreamTranscoderList

    • getTimedTextProviderConfig

      com.wowza.wms.timedtext.model.TimedTextProviderConfiguration getTimedTextProviderConfig()
      Get the config of TimedTextProviders
      Returns:
      TimedTextProviders config

    • getStartupStreams

      List<com.wowza.wms.vhost.StartupStream> getStartupStreams()
      Get the list of streams to start at virtual host startup
      Returns:
      list of streams to start at virtual host startup

    • addStartupStream

      void addStartupStream(com.wowza.wms.vhost.StartupStream startupStream)
      Add a stream to the list of streams to start and virtual host startup
      Parameters:
      startupStream - startup stream

    • isStartStarupStreams

      boolean isStartStarupStreams()
      Returns true if the startup streams are to start and vhost startup
      Returns:
      true if the startup streams are to start and vhost startup

    • setStartStarupStreams

      void setStartStarupStreams(boolean startStarupStreams)
      Set to true to startup startup stream as vhost startup
      Parameters:
      startStarupStreams - true if the startup streams are to start and vhost startup

    • startStartupStreams

      void startStartupStreams()
      Method to start startup streams

    • stopStartupStreams

      void stopStartupStreams()
      Method to stop startup streams

    • getDvrRecorderList

      com.wowza.wms.stream.livedvr.DvrRecorderList getDvrRecorderList()
      Get the DvrRecorderList
      Returns:
      list of DVR Recorders

    • getDvrStoreList

      com.wowza.wms.dvr.model.DvrStoreList getDvrStoreList()
      Get the list of DVR Stores
      Returns:
      list of DVR Stores

    • getLiveStreamRecordManager

      ILiveStreamRecordManager getLiveStreamRecordManager()
      Returns the LiveStreamRecordManager associated with this vhost This object contains the active LiveStreamRecorders
      Returns:
      ILiveStreamRecordManager associated with this vhost

    • getPushPublishManager

      com.wowza.wms.pushpublish.manager.IPushPublishManager getPushPublishManager()
      Returns the PushPbulishManager associated with this vhost This object provides access to PushPublers associated with
      Returns:
      IPushPublishManager associated with this vhost

    • getMediaReaderContentType

      int getMediaReaderContentType(String mediaType)
      Get the content type of a media stream name prefix (see IMediaReader.CONTENTTYPE_*)
      Parameters:
      mediaType - mediaType (such as flv or smil)
      Returns:
      content type (see IMediaReader.CONTENTTYPE_*)

    • getProtocolUsage

      void getProtocolUsage(boolean[] protocolsInUse)
      Get the protocols in use by this application instance (see IApplicationInstance.PROTCOLUSAGE_*)

    • getTranscoderVODContext

      com.wowza.wms.transcoder.vod.TranscoderVODContext getTranscoderVODContext()
      Get the VOD transcoder context
      Returns:
      VOD transcoder context

    • getThumbnailerContext

      com.wowza.wms.transcoder.thumbnailer.ThumbnailerContext getThumbnailerContext()
      Get the VOD transcoder context
      Returns:
      VOD transcoder context

    • getHTTPStreamerRequestValidator

      IVHostHTTPStreamerRequestValidator getHTTPStreamerRequestValidator()
      Get the HTTP streamer request validator
      Returns:
      HTTP streamer request validator

    • setHTTPStreamerRequestValidator

      void setHTTPStreamerRequestValidator(IVHostHTTPStreamerRequestValidator httpRequestValidator)
      Set the HTTP streamer request validator
      Parameters:
      httpRequestValidator - HTTP streamer request validator

    • getHTTPStreamerMaxPathLen

      int getHTTPStreamerMaxPathLen()
      Get the max HTTP streamer path length
      Returns:
      max HTTP streamer path length

    • setHTTPStreamerMaxPathLen

      void setHTTPStreamerMaxPathLen(int httpStreamerMaxPathLen)
      Set the max HTTP streamer path length
      Parameters:
      httpStreamerMaxPathLen - max HTTP streamer path length

    • getRTSPRequestValidator

      IVHostRTSPRequestValidator getRTSPRequestValidator()
      Get the RTSP request validator
      Returns:
      RTSP request validator

    • setRTSPRequestValidator

      void setRTSPRequestValidator(IVHostRTSPRequestValidator rtspRequestValidator)
      Set the RTSP request validator
      Parameters:
      rtspRequestValidator - RTSP request validator

    • getRTSPMaxPathLen

      int getRTSPMaxPathLen()
      Get the max RTSP stream path length
      Returns:
      max RTSP stream path length

    • setRTSPMaxPathLen

      void setRTSPMaxPathLen(int rtspStreamerMaxPathLen)
      Set the max RTSP stream path length
      Parameters:
      rtspStreamerMaxPathLen - max RTSP stream path length

    • getLiveStreamTranscoderSessionCount

      long getLiveStreamTranscoderSessionCount()
      Get the current number of live stream transcoder sessions.
      Returns:
      current number of live stream transcoder sessions

    • getPushPublishContext

      PushPublishContext getPushPublishContext()
      Get the push publish context
      Returns:
      push publish context

    • getUnidentifiedSessionTimeout

      int getUnidentifiedSessionTimeout()
      Get the unidentified session timeout (TCP session that we are not able to identifiy)
      Returns:
      timeout in milliseconds

    • setUnidentifiedSessionTimeout

      void setUnidentifiedSessionTimeout(int unidentifiedSessionTimeout)
      Set the unidentified session timeout (TCP session that we are not able to identifiy)
      Parameters:
      unidentifiedSessionTimeout - timeout in milliseconds

    • getStartupStreamsDelayTime

      int getStartupStreamsDelayTime()
      Get startup streams delay time (milliseconds). Time between items started in StartupStreams.xml.
      Returns:
      delay time

    • setStartupStreamsDelayTime

      void setStartupStreamsDelayTime(int startupStreamsDelayTime)
      Set startup streams delay time (milliseconds). Time between items started in StartupStreams.xml.
      Parameters:
      startupStreamsDelayTime - delay time

    • getHTTPPersistentRejectInvalid

      boolean getHTTPPersistentRejectInvalid()
      Get HTTPPersisent rejection status. Default is false.
      Returns:
      status

    • setHTTPPersistentRejectInvalid

      void setHTTPPersistentRejectInvalid(boolean flag)
      Set if invalid HTTP requests should be rejected when using persistent connections
      Parameters:
      flag - enable/disable

    • isWebRTCSessionFactory

      boolean isWebRTCSessionFactory()
      Is WebRTC enabled for this virtual host
      Returns:
      true if WebRTC is enabled

    • getWebRTCSessionFactory

      com.wowza.wms.webrtc.tcpsession.IWebRTCTCPSessionFactory getWebRTCSessionFactory()
      Get WebRTC session factory
      Returns:
      WebRTC session factory

    • getWebSocketContext

      WebSocketContext getWebSocketContext()
      Get the WebSocket Context
      Returns:
      WebSocket Context

    • getHTTPProviderContext

      com.wowza.wms.http.HTTPProviderContext getHTTPProviderContext()
      Get the HTTPProvider Context
      Returns:
      HTTPProvider Context

    • getWebSocketSessions

      List<IWebSocketSession> getWebSocketSessions()
      Get a list of active WebSocket sessions
      Returns:
      list of active WebSocket sessions

    • getWebSocketSessionCount

      int getWebSocketSessionCount()
      Get the total number of WebSocket sessions
      Returns:
      total number of WebSocket sessions

    • getDomainToKeyStoreMapList

      com.wowza.wms.vhost.DomainToKeyStoreMapList getDomainToKeyStoreMapList()
      Get the SSL certificate map list. It is a list of maps that map domain names to SSL certificates.
      Returns:
      SSL certificate map list