Package com.wowza.wms.transport.media

Interface IMediaTransportProviderConfiguration

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addCustomHeader​(String name, String value)
      Add a custom output header for this configuration item.
      boolean getAttributeBoolean​(String name)
      Attempt to get a boolean attribute with the name specified.
      int getAttributeInt​(String name)
      Attempt to get an int attribute with the name specified.
      long getAttributeLong​(String name)
      Attempt to get a long attribute with the name specified.
      java.util.Set<String> getAttributeNames()
      Get a list of all the attribute names set.
      String getAttributeString​(String name)
      Attempt to get a string attribute with the name specified.
      String getConfigurationName()
      Get the name of this configuration item.
      java.util.HashMap<String,​String> getCustomHeaders()
      Get all the custom headers set.
      boolean getDebug()
      Get the debug flag for this configuration object.
      WMSProperties getProperties()
      Get the WMSProperties holder.
      java.util.HashMap<String,​String> getTransportHeaderOutput​(java.util.HashMap<String,​byte[]> dynamictransportinformation, IMediaTransportObject transportObject)
      This should be called by the transport provider using this configuration item.
      void init()
      Initialise the provider configuration.
      boolean isReady()
      Get the ready flag for this configuration object.
      void removeCustomHeader​(String name)
      Remove a custom output header
      void setAttributeBoolean​(String name, boolean value)
      Set an attribute with a boolean type
      void setAttributeInt​(String name, int value)
      Set an attribute with an int type
      void setAttributeLong​(String name, long value)
      Set an attribute with a long type
      void setAttributeString​(String name, String value)
      Set an attribute with a string type
      void setConfigurationName​(String name)
      Set the name of this configuration object.
      void setDebug​(boolean debug)
      Set the debug flag for this configuration object.
      void setIsReady​(boolean ready)
      Set if this configuration object is ready.
      void setProperties​(WMSProperties props)
      When the object is created a WMSProperties holder is created.

    • Method Detail

      • init

        void init()
        Initialise the provider configuration. This should only be called when all appropriate attributes have been set.

      • setConfigurationName

        void setConfigurationName​(String name)
        Set the name of this configuration object.
        Parameters:
        String -

      • getConfigurationName

        String getConfigurationName()
        Get the name of this configuration item.
        Returns:
        String

      • addCustomHeader

        void addCustomHeader​(String name,
                     String value)
        Add a custom output header for this configuration item. This is more geared towards HTTP transport providers but can be used by any transport provider.
        Parameters:
        String -
        String -

      • removeCustomHeader

        void removeCustomHeader​(String name)
        Remove a custom output header
        Parameters:
        String -

      • getCustomHeaders

        java.util.HashMap<String,​String> getCustomHeaders()
        Get all the custom headers set.
        Returns:
        HashMap

      • setAttributeString

        void setAttributeString​(String name,
                        String value)
        Set an attribute with a string type
        Parameters:
        name -
        value -

      • setAttributeBoolean

        void setAttributeBoolean​(String name,
                         boolean value)
        Set an attribute with a boolean type
        Parameters:
        name -
        boolean -

      • setAttributeLong

        void setAttributeLong​(String name,
                      long value)
        Set an attribute with a long type
        Parameters:
        name -
        long -

      • setAttributeInt

        void setAttributeInt​(String name,
                     int value)
        Set an attribute with an int type
        Parameters:
        name -
        int -

      • getAttributeString

        String getAttributeString​(String name)
        Attempt to get a string attribute with the name specified. If the attribute is not found a null should be returned.
        Parameters:
        name -
        Returns:
        String

      • getAttributeBoolean

        boolean getAttributeBoolean​(String name)
        Attempt to get a boolean attribute with the name specified. If the attribute is not found false should be returned.
        Parameters:
        name -
        Returns:
        boolean

      • getAttributeLong

        long getAttributeLong​(String name)
        Attempt to get a long attribute with the name specified. If the attribute is not found -1 should be returned.
        Parameters:
        name -
        Returns:
        long

      • getAttributeInt

        int getAttributeInt​(String name)
        Attempt to get an int attribute with the name specified. If the attribute is not found -1 should be returned.
        Parameters:
        name -
        Returns:
        int

      • getAttributeNames

        java.util.Set<String> getAttributeNames()
        Get a list of all the attribute names set.
        Returns:
        Set

      • getTransportHeaderOutput

        java.util.HashMap<String,​String> getTransportHeaderOutput​(java.util.HashMap<String,​byte[]> dynamictransportinformation,
                                                                IMediaTransportObject transportObject)
        This should be called by the transport provider using this configuration item. You can pass in two objects, one is a HashMap and the other is a IMediaTransportObject The result should be a HashMap that the transport provider can then use to process the data block being transported.
        Parameters:
        HashMap -
        IMediaTransportObject -
        Returns:
        HashMap

      • setProperties

        void setProperties​(WMSProperties props)
        When the object is created a WMSProperties holder is created. This can be changed by setting it with this call. All attributes should be stored within a WMSProperties object
        Parameters:
        WMSProperties -

      • getProperties

        WMSProperties getProperties()
        Get the WMSProperties holder.
        Returns:
        WMSProperties

      • setIsReady

        void setIsReady​(boolean ready)
        Set if this configuration object is ready. It should be set after init() is called and therefore after any attributes have been set.
        Parameters:
        boolean -

      • isReady

        boolean isReady()
        Get the ready flag for this configuration object.
        Returns:
        boolean

      • setDebug

        void setDebug​(boolean debug)
        Set the debug flag for this configuration object.
        Parameters:
        boolean -

      • getDebug

        boolean getDebug()
        Get the debug flag for this configuration object.
        Returns:
        boolean