Menu
Extensibility Solutions
  • Plug-Ins
  • Tools
  • Filters
  • Scripts
    • Developer Documentation
  • OmniEngine Plugin API
  • OmniPeek Plugin API
  • OmniScript Reference
  • Peek COM API Reference
  • Decoder Language Reference
  • ProtoSpecs XML Guidelines
  • Peek Reporting Framework
  • Automation Primer
  • Plug-in Primer
    • Network media utilities. More...

    List of all members.

    Public Member Functions

    HRESULT GetMediaString ([in] enum TMediaType mt,[out, retval] BSTR *pbstr)
    HRESULT GetMediaSubTypeString ([in] enum TMediaSubType mst,[out, retval] BSTR *pbstr)
    HRESULT GetMediaClassString ([in] enum TMediaSpecClass msc,[out, retval] BSTR *pbstr)
    HRESULT GetMediaTypeString ([in] enum TMediaSpecType mst,[out, retval] BSTR *pbstr)
    HRESULT GetMediaTypePrefix ([in] enum TMediaSpecType mst,[out, retval] BSTR *pbstr)
    HRESULT GetMediaTypeDefault ([in] enum TMediaSpecType mst,[out, retval] BSTR *pbstr)
    HRESULT SpecToString ([in] TMediaSpec *pSpec,[out, retval] BSTR *pbstr)
    HRESULT StringToSpec ([in] BSTR bstrSpec,[in] enum TMediaSpecType mst,[out] TMediaSpec *pSpec)

    Detailed Description

    This interface is implemented by the Omnipeek console and Omnił Engine and provides access to network media information.

    Member Function Documentation

    HRESULT IMediaUtils::GetMediaClassString (  [in] enum TMediaSpecClass  msc,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get the name for a media spec class.

    Parameters:
    msc The media spec class.
    pbstr Pointer to a BSTR that holds the name.
    Return values:
    S_OK Success
    E_INVALIDARG The non-pointer parameter is invalid.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::GetMediaString (  [in] enum TMediaType  mt,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get the name for a media type.

    Parameters:
    mt The media type.
    pbstr Pointer to a BSTR that holds the name.
    Return values:
    S_OK Success
    E_INVALIDARG The non-pointer parameter is invalid.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::GetMediaSubTypeString (  [in] enum TMediaSubType  mst,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get the name for a media sub type.

    Parameters:
    mst The media sub type.
    pbstr Pointer to a BSTR that holds the name.
    Return values:
    S_OK Success
    E_INVALIDARG The non-pointer parameter is invalid.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::GetMediaTypeDefault (  [in] enum TMediaSpecType  mst,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get a default formatted string for a media spec type.

    Parameters:
    mst The media spec type.
    pbstr Pointer to a BSTR that holds the default.
    Return values:
    S_OK Success
    E_INVALIDARG The non-pointer parameter is invalid.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::GetMediaTypePrefix (  [in] enum TMediaSpecType  mst,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get the prefix for a media spec type.

    Parameters:
    mst The media spec type.
    pbstr Pointer to a BSTR that holds the prefix.
    Return values:
    S_OK Success
    E_INVALIDARG The non-pointer parameter is invalid.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::GetMediaTypeString (  [in] enum TMediaSpecType  mst,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get the name for a media spec type.

    Parameters:
    mst The media spec type.
    pbstr Pointer to a BSTR that holds the name.
    Return values:
    S_OK Success
    E_INVALIDARG The non-pointer parameter is invalid.
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::SpecToString (  [in] TMediaSpec *  pSpec,
    [out, retval] BSTR *  pbstr
    ) 
     

    Get a string for a media spec.

    Parameters:
    pSpec Pointer to the media spec.
    pbstr Pointer to a BSTR that holds the string.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IMediaUtils::StringToSpec (  [in] BSTR  bstrSpec,
    [in] enum TMediaSpecType  mst,
    [out] TMediaSpec *  pSpec
    ) 
     

    Get a media spec from a string.

    Parameters:
    bstrSpec The string to be converted into a media spec.
    mst The media spec type.
    pSpec Pointer to a variable that receives the media spec.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None