C# Class Microsoft.Protocols.TestTools.StackSdk.RemoteDesktop.Rdpegfx.RDPGFX_WIRE_TO_SURFACE_PDU_2

The RDPGFX_WIRE_TO_SURFACE_PDU_2 message is used to transfer encoded bitmap data progressively from the server to a client-side destination surface. It support RFX progressive Codec only.

Inheritance: RdpegfxServerPdu

Mostrar archivo Open project: Microsoft/WindowsProtocolTestSuites

Public Properties

Property	Type	Description
bitmapData	byte[]
bitmapDataLength	uint
codecContextId	uint
codecId	CodecType
pixelFormat	PixelFormat
surfaceId	ushort

Public Methods

Method	Description
Decode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : bool	Decode this PDU from the PduMarshaler.
Encode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : void	Encode this PDU to the PduMarshaler.
RDPGFX_WIRE_TO_SURFACE_PDU_2 ( ) : System	Constructor
RDPGFX_WIRE_TO_SURFACE_PDU_2 ( ushort sId, uint codecCtxId, PixelFormat pixFormat, byte bmData ) : System	Constructor, create a wire to surface message to transfer a bitmap.

Method Details

Decode() public method

Decode this PDU from the PduMarshaler.

public Decode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : bool
marshaler	Microsoft.Protocols.TestTools.StackSdk.PduMarshaler	This is used to decode the fields of this PDU.
return	bool

Encode() public method

Encode this PDU to the PduMarshaler.

public Encode ( Microsoft.Protocols.TestTools.StackSdk.PduMarshaler marshaler ) : void
marshaler	Microsoft.Protocols.TestTools.StackSdk.PduMarshaler	This is used to encode the fields of this PDU.
return	void

RDPGFX_WIRE_TO_SURFACE_PDU_2() public method

Constructor

public RDPGFX_WIRE_TO_SURFACE_PDU_2 ( ) : System
return	System

RDPGFX_WIRE_TO_SURFACE_PDU_2() public method

Constructor, create a wire to surface message to transfer a bitmap.

public RDPGFX_WIRE_TO_SURFACE_PDU_2 ( ushort sId, uint codecCtxId, PixelFormat pixFormat, byte bmData ) : System
sId	ushort	This is used to indicate the target surface id.
codecCtxId	uint	This is used to indicate the codecContextId.
pixFormat	PixelFormat	This is used to indicate the pixel format to fill target surface.
bmData	byte	This is used to indicate the bitmap data encoded by cId codec.
return	System

Property Details

bitmapData public_oe property

A variable-length array of bytes. specify bitmap data encoded using the codec identified by the ID in the codecId field.

public byte[] bitmapData
return	byte[]

bitmapDataLength public_oe property

A 32-bit, unsigned integer. Specify the length, in bytes, of the bitmapData field.

public uint bitmapDataLength
return	uint

codecContextId public_oe property

A 32-bit, unsigned integer. Specify the compression context associated with the bitmap data encapsulated in the bitmapData field.

public uint codecContextId
return	uint

codecId public_oe property

A 16-bit, unsigned integer. specify the codec that was used to encode the bitmap data encapsulated in the bitmapData field. must be RDPGFX_CODECID_CAPROGRESSIVE(0x0009)

public CodecType codecId
return	CodecType

pixelFormat public_oe property

A 8-bit, unsigned integer. specify the pixel format of the decoded bitmap data

public PixelFormat pixelFormat
return	PixelFormat

surfaceId public_oe property

A 16-bit, unsigned integer. specify the ID of the destination surface.

public ushort surfaceId
return	ushort