Interface IMediaTransportResponse


public interface IMediaTransportResponse
IMediaTransportResponse This object is provided as part of the IMediaTransportProviderListener callback. This is an internal object/class.
  • Field Details

  • Method Details

    • setUUID

      void setUUID(String id)
      Sets the UUID of the response object. This should match the IMediaTransportDataObject UUID created when it was initialised.
      Parameters:
      String -
    • getUUID

      String getUUID()
      Get the UUID of the object.
      Returns:
      String
    • setPath

      void setPath(String path)
      Set the path for the response object. This should match the IMediaTransportDataObject path setting.
      Parameters:
      String -
    • getPath

      String getPath()
      Get the path for the response object.
      Returns:
      String
    • setContentType

      void setContentType(String contenttype)
      Set the content type for the response object. This should match the IMediaTransportDataObject content type setting.
      Parameters:
      String -
    • getContentType

      String getContentType()
      Get the content type for the response object.
      Returns:
      String
    • setCommand

      void setCommand(String command)
      Set the command type for the response object. This should match the IMediaTransportDataObject command setting.
      Parameters:
      String -
    • getCommand

      String getCommand()
      Get the command for the response object.
      Returns:
      String
    • setbasicMessage

      void setbasicMessage(String basicMessage)
      Set a basic message for the response object. This allows basic string messages for state to be available in the IMediaTransportProviderListener callback. A common message would be SUCCESS or FAILED.
      Parameters:
      String -
    • getBasicMessage

      String getBasicMessage()
      Get the basic message for the response object.
      Returns:
      String
    • setSuccess

      void setSuccess(boolean success)
      Set the success flag for the response object. If the transport was successful then it should be set to true.
      Parameters:
      boolean -
    • getSuccess

      boolean getSuccess()
      Get the success flag from the response object.
      Returns:
      boolean
    • addSuccessData

      void addSuccessData(String key, byte[] data)
      In order to provide as much flexibility as possible it is possible to add 'success' data to the response object in the form of a key and a byte array. An example would be as follows MediaTransportConfigurationHTTP.RESPONSE_INDICATOR, String.valueOf("200").getBytes()); This is done within the MediaTransportProviderhHTTP and allows the response code 200 to be added into the success data. There are 3 defined responses, although you can add any you wish IMediaTransportProviderConfiguration.RESPONSE_INDICATOR IMediaTransportProviderConfiguration.RESPONSE_HEADERS IMediaTransportProviderConfiguration.RESPONSE_DATA
      Parameters:
      key -
      data -
    • getSuccessData

      byte[] getSuccessData(String key)
      Get the success data available
      Parameters:
      String -
      Returns:
      byte[]
    • getSuccessKeyList

      List<String> getSuccessKeyList()
      Get the list of keys that the success data contains.
      Returns:
      List