Content Pipes

Data Structures
struct	OMX_PARAM_CONTENTURITYPE
struct	OMX_PARAM_CONTENTPIPETYPE
struct	CP_PIPETYPE
Typedefs
typedef struct OMX_PARAM_CONTENTURITYPE	OMX_PARAM_CONTENTURITYPE
typedef struct OMX_PARAM_CONTENTPIPETYPE	OMX_PARAM_CONTENTPIPETYPE
typedef enum CP_ORIGINTYPE	CP_ORIGINTYPE
typedef enum CP_ACCESSTYPE	CP_ACCESSTYPE
typedef enum CP_CHECKBYTESRESULTTYPE	CP_CHECKBYTESRESULTTYPE
typedef enum CP_EVENTTYPE	CP_EVENTTYPE
typedef struct CP_PIPETYPE	CP_PIPETYPE
Enumerations
enum	CP_ORIGINTYPE {   CP_OriginBegin, CP_OriginCur, CP_OriginEnd, CP_OriginKhronosExtensions = 0x6F000000,   CP_OriginVendorStartUnused = 0x7F000000, CP_OriginMax = 0X7FFFFFFF }
enum	CP_ACCESSTYPE {   CP_AccessRead, CP_AccessWrite, CP_AccessReadWrite, CP_AccessKhronosExtensions = 0x6F000000,   CP_AccessVendorStartUnused = 0x7F000000, CP_AccessMax = 0X7FFFFFFF }
enum	CP_CHECKBYTESRESULTTYPE {   CP_CheckBytesOk, CP_CheckBytesNotReady, CP_CheckBytesInsufficientBytes, CP_CheckBytesAtEndOfStream,   CP_CheckBytesOutOfBuffers, CP_CheckBytesKhronosExtensions = 0x6F000000, CP_CheckBytesVendorStartUnused = 0x7F000000, CP_CheckBytesMax = 0X7FFFFFFF }
enum	CP_EVENTTYPE {   CP_BytesAvailable, CP_Overflow, CP_PipeDisconnected, CP_EventKhronosExtensions = 0x6F000000,   CP_EventVendorStartUnused = 0x7F000000, CP_EventMax = 0X7FFFFFFF }
Functions
OMX_API OMX_ERRORTYPE	OMX_GetContentPipe (OMX_OUT OMX_HANDLETYPE *hPipe, OMX_IN OMX_STRING szURI)

---

Typedef Documentation

typedef enum CP_ACCESSTYPE CP_ACCESSTYPE

enumeration of contact access types used in the CP_PIPETYPE's Open function

typedef enum CP_CHECKBYTESRESULTTYPE CP_CHECKBYTESRESULTTYPE

enumeration of results returned by the CP_PIPETYPE's CheckAvailableBytes function

typedef enum CP_EVENTTYPE CP_EVENTTYPE

enumeration of content pipe events sent to the client callback.

typedef enum CP_ORIGINTYPE CP_ORIGINTYPE

enumeration of origin types used in the CP_PIPETYPE's Seek function

typedef struct CP_PIPETYPE CP_PIPETYPE

content pipe definition

typedef struct OMX_PARAM_CONTENTPIPETYPE OMX_PARAM_CONTENTPIPETYPE

typedef struct OMX_PARAM_CONTENTURITYPE OMX_PARAM_CONTENTURITYPE

---

Enumeration Type Documentation

enum CP_ACCESSTYPE

enumeration of contact access types used in the CP_PIPETYPE's Open function

Enumerator:

CP_AccessRead
CP_AccessWrite
CP_AccessReadWrite
CP_AccessKhronosExtensions	Reserved region for introducing Khronos Standard Extensions
CP_AccessVendorStartUnused	Reserved region for introducing Vendor Extensions
CP_AccessMax

Definition at line 89 of file OMX_ContentPipe.h.

enum CP_CHECKBYTESRESULTTYPE

enumeration of results returned by the CP_PIPETYPE's CheckAvailableBytes function

Enumerator:

CP_CheckBytesOk	There are at least the request number of bytes available
CP_CheckBytesNotReady	The pipe is still retrieving bytes and presently lacks sufficient bytes. Client will be called when they are sufficient bytes are available.
CP_CheckBytesInsufficientBytes	The pipe has retrieved all bytes but those available are less than those requested
CP_CheckBytesAtEndOfStream	The pipe has reached the end of stream and no more bytes are available.
CP_CheckBytesOutOfBuffers	All read/write buffers are currently in use.
CP_CheckBytesKhronosExtensions	Reserved region for introducing Khronos Standard Extensions
CP_CheckBytesVendorStartUnused	Reserved region for introducing Vendor Extensions
CP_CheckBytesMax

Definition at line 101 of file OMX_ContentPipe.h.

enum CP_EVENTTYPE

enumeration of content pipe events sent to the client callback.

Enumerator:

CP_BytesAvailable
CP_Overflow	bytes requested in a CheckAvailableBytes call are now available
CP_PipeDisconnected	enumeration of content pipe events sent to the client callback
CP_EventKhronosExtensions	enumeration of content pipe events sent to the client callback Reserved region for introducing Khronos Standard Extensions
CP_EventVendorStartUnused	Reserved region for introducing Vendor Extensions
CP_EventMax

Definition at line 123 of file OMX_ContentPipe.h.

enum CP_ORIGINTYPE

enumeration of origin types used in the CP_PIPETYPE's Seek function

Enumerator:

CP_OriginBegin
CP_OriginCur
CP_OriginEnd
CP_OriginKhronosExtensions	Reserved region for introducing Khronos Standard Extensions
CP_OriginVendorStartUnused	Reserved region for introducing Vendor Extensions
CP_OriginMax

Definition at line 77 of file OMX_ContentPipe.h.

---

Function Documentation

OMX_API OMX_ERRORTYPE OMX_GetContentPipe	(	OMX_OUT OMX_HANDLETYPE *	hPipe,
		OMX_IN OMX_STRING	szURI
	)