[MS-RRSP2]:
Remote Rendering Server Protocol Version 2.0
Intellectual Property Rights Notice for Open Specifications Documentation
Technical Documentation. Microsoft publishes Open Specifications documentation for protocols, file formats, languages, standards as well as overviews of the interaction among each of these technologies.
Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you may make copies of it in order to develop implementations of the technologies described in the Open Specifications and may distribute portions of it in your implementations using these technologies or your documentation as necessary to properly document the implementation. You may also distribute in your implementation, with or without modification, any schema, IDL's, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications.
No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
Patents. Microsoft has patents that may cover your implementations of the technologies described in the Open Specifications. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, a given Open Specification may be covered by Microsoft Open Specification Promise or the Community Promise. If you would prefer a written license, or if the technologies described in the Open Specifications are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .
Trademarks. The names of companies and products contained in this documentation may be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit
Fictitious Names. The example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than specifically described above, whether by implication, estoppel, or otherwise.
Tools. The Open Specifications do not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments you are free to take advantage of them. Certain Open Specifications are intended for use in conjunction with publicly available standard specifications and network programming art, and assumes that the reader either is familiar with the aforementioned material or has immediate access to it.
Revision Summary
Date / Revision History / Revision Class / Comments8/27/2010 / 0.1 / New / Released new document.
10/8/2010 / 0.1 / None / No changes to the meaning, language, or formatting of the technical content.
11/19/2010 / 0.1 / None / No changes to the meaning, language, or formatting of the technical content.
1/7/2011 / 0.1 / None / No changes to the meaning, language, or formatting of the technical content.
2/11/2011 / 0.1 / None / No changes to the meaning, language, or formatting of the technical content.
3/25/2011 / 0.1 / None / No changes to the meaning, language, or formatting of the technical content.
5/6/2011 / 0.1 / None / No changes to the meaning, language, or formatting of the technical content.
6/17/2011 / 0.2 / Minor / Clarified the meaning of the technical content.
9/23/2011 / 0.2 / None / No changes to the meaning, language, or formatting of the technical content.
12/16/2011 / 1.0 / Major / Updated and revised the technical content.
3/30/2012 / 1.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/12/2012 / 1.0 / None / No changes to the meaning, language, or formatting of the technical content.
10/25/2012 / 1.0 / None / No changes to the meaning, language, or formatting of the technical content.
1/31/2013 / 2.0 / Major / Updated and revised the technical content.
8/8/2013 / 3.0 / Major / Updated and revised the technical content.
11/14/2013 / 4.0 / Major / Updated and revised the technical content.
2/13/2014 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
5/15/2014 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/30/2015 / 5.0 / Major / Significantly changed the technical content.
10/16/2015 / 5.0 / No Change / No changes to the meaning, language, or formatting of the technical content.
Table of Contents
1Introduction
1.1Glossary
1.2References
1.2.1Normative References
1.2.2Informative References
1.3Protocol Overview (Synopsis)
1.3.1User Experience
1.3.1.1Internal Componentization
1.3.2Rendering Engine
1.3.2.1Addressing Mechanism
1.3.3Message Sequence
1.4Relationship to Other Protocols
1.5Prerequisites/Preconditions
1.6Applicability Statement
1.7Versioning and Capability Negotiation
1.8Vendor-Extensible Fields
1.9Standards Assignments
2Messages
2.1Transport
2.2Message Syntax
2.2.1Initialization Messages (Handshake)
2.2.1.1RemoteClientInformation message
2.2.1.2RemoteServerInformation message
2.2.2Command Messages
2.2.2.1Command Message
2.2.3Framing Messages
2.2.3.1BufferInfo Message
2.2.3.2MessageBatch Message
2.2.3.3MessageBatchEntry Message
2.2.4Payload Messages
2.2.4.1DataBuffer
2.2.4.1.1DataBuffer_RegisterOwner
2.2.4.2ContextRelay
2.2.4.2.1ContextRelay_Create
2.2.4.2.2ContextRelay_UnlinkContext
2.2.4.2.3ContextRelay_LinkContext
2.2.4.3Broker
2.2.4.3.1Broker_DestroyObject
2.2.4.3.2Broker_CreateObject
2.2.4.3.3Broker_CreateClass
2.2.4.4Context
2.2.4.4.1Context_ForwardMessage
2.2.4.4.2Context_DestroyGroup
2.2.4.4.3Context_CreateGroup
2.2.4.5RenderBuilder
2.2.4.5.1RenderBuilder_Create
2.2.4.5.2RenderBuilder_Clear
2.2.4.6Visual
2.2.4.6.1Visual_Create
2.2.4.6.2Visual_ChangeDataBits
2.2.4.6.3Visual_ChangeParent
2.2.4.6.4Visual_SetColor
2.2.4.6.5Visual_SetAlpha
2.2.4.6.6Visual_SetLayer
2.2.4.6.7Visual_SetRotation
2.2.4.6.8Visual_SetCenterPointScale
2.2.4.6.9Visual_SetCenterPointOffset
2.2.4.6.10Visual_SetScale
2.2.4.6.11Visual_SetSize
2.2.4.6.12Visual_SetPosition
2.2.4.6.13Visual_SetContent
2.2.4.6.14Visual_SetVisible
2.2.4.7AnimationManager
2.2.4.7.1AnimationManager_Create
2.2.4.7.2AnimationManager_BuildGradientColorMaskAnimation
2.2.4.7.3AnimationManager_BuildGradientOffsetAnimation
2.2.4.7.4AnimationManager_BuildRotationAnimation
2.2.4.7.5AnimationManager_BuildSizeAnimation
2.2.4.7.6AnimationManager_BuildScaleAnimation
2.2.4.7.7AnimationManager_BuildPositionAnimation
2.2.4.7.8AnimationManager_BuildColorAnimation
2.2.4.7.9AnimationManager_BuildAlphaAnimation
2.2.4.8WaitCursor
2.2.4.8.1WaitCursor_Create
2.2.4.8.2WaitCursor_Show
2.2.4.8.3WaitCursor_Hide
2.2.4.8.4WaitCursor_SetVisuals
2.2.4.8.5WaitCursor_SetShowAnimations
2.2.4.8.6WaitCursor_SetHideAnimations
2.2.4.9Device
2.2.4.9.1Device_Stop
2.2.4.9.2Device_Restart
2.2.4.9.3Device_DrawLine
2.2.4.9.4Device_DrawOutline
2.2.4.9.5Device_DrawSolid
2.2.4.9.6Device_CreateSurfacePool
2.2.4.10Window
2.2.4.10.1Window_SetBackgroundColor
2.2.4.10.2Window_SetPerspectiveSettings
2.2.4.10.3Window_ChangeDataBits
2.2.4.10.4Window_SetContent
2.2.4.10.5Window_SetRoot
2.2.4.11Surface
2.2.4.11.1Surface_DrawGrid
2.2.4.11.2Surface_Draw
2.2.4.11.3Surface_RemapContainer
2.2.4.11.4Surface_RemapLocation
2.2.4.11.5Surface_MarkContentValid
2.2.4.11.6Surface_Clear
2.2.4.11.7Surface_SetRotation
2.2.4.11.8Surface_SetStorageSize
2.2.4.12SurfacePool
2.2.4.12.1SurfacePool_Draw
2.2.4.12.2SurfacePool_CreateSurface
2.2.4.12.3SurfacePool_Free
2.2.4.12.4SurfacePool_Allocate
2.2.4.12.5SurfacePool_SetEmptyColor
2.2.4.12.6SurfacePool_SetPriority
2.2.4.13VideoPool
2.2.4.13.1VideoPool_Draw
2.2.4.13.2VideoPool_CreateSurface
2.2.4.13.3VideoPool_Free
2.2.4.13.4VideoPool_Allocate
2.2.4.13.5VideoPool_SetEmptyColor
2.2.4.13.6VideoPool_SetPriority
2.2.4.13.7VideoPool_SetContentOverscan
2.2.4.13.8VideoPool_NotifyVideoSizeChanged
2.2.4.14Rasterizer
2.2.4.14.1Rasterizer_LoadRawImage
2.2.4.15Gradient
2.2.4.15.1Gradient_Pop
2.2.4.15.2Gradient_Push
2.2.4.15.3Gradient_Draw
2.2.4.15.4Gradient_Clear
2.2.4.15.5Gradient_AddValue
2.2.4.15.6Gradient_SetOffset
2.2.4.15.7Gradient_SetColorMask
2.2.4.15.8Gradient_SetOrientation
2.2.4.16Line
2.2.4.16.1Line_SetThickness
2.2.4.16.2Line_SetColor
2.2.4.16.3Line_CommitLine
2.2.4.16.4Line_DrawPoint
2.2.4.17Animation
2.2.4.17.1Animation_AddCompletionLink
2.2.4.17.2Animation_SetEaseOut
2.2.4.17.3Animation_SetEaseIn
2.2.4.17.4Animation_SetBezier
2.2.4.17.5Animation_SetCosine
2.2.4.17.6Animation_SetSine
2.2.4.17.7Animation_SetSCurve
2.2.4.17.8Animation_SetLogarithmic
2.2.4.17.9Animation_SetLinear
2.2.4.17.10Animation_SetExponential
2.2.4.17.11Animation_SetDynamicRotation
2.2.4.17.12Animation_SetRotation
2.2.4.17.13Animation_SetColorF
2.2.4.17.14Animation_SetDynamicARGBColor
2.2.4.17.15Animation_SetDynamicRGBColor
2.2.4.17.16Animation_SetARGBColor
2.2.4.17.17Animation_SetRGBColor
2.2.4.17.18Animation_SetDynamicVector3
2.2.4.17.19Animation_SetVector3
2.2.4.17.20Animation_SetDynamicFloat
2.2.4.17.21Animation_SetFloat
2.2.4.17.22Animation_RemoveCallback
2.2.4.17.23Animation_AddCallback
2.2.4.17.24Animation_AddKeyframe
2.2.4.17.25Animation_Stop
2.2.4.17.26Animation_Play
2.2.4.17.27Animation_SetStopCommand
2.2.4.17.28Animation_SetAutoStop
2.2.4.17.29Animation_SetRepeatCount
2.2.4.17.30Animation_SetKeyframeTime
2.2.4.17.31Animation_SetKeyframeCount
2.2.4.18DynamicSurfaceFactory
2.2.4.18.1DynamicSurfaceFactory_CloseInstance
2.2.4.18.2DynamicSurfaceFactory_CreateVideoInstance
2.2.4.18.3DynamicSurfaceFactory_CreateSurfaceInstance
2.2.4.19SoundBuffer
2.2.4.19.1SoundBuffer_LoadSoundData
2.2.4.20Sound
2.2.4.20.1Sound_Stop
2.2.4.20.2Sound_Play
2.2.4.21SoundDevice
2.2.4.21.1SoundDevice_CreateSound
2.2.4.21.2SoundDevice_CreateSoundBuffer
2.2.4.21.3SoundDevice_EvictExternalResources
2.2.4.21.4SoundDevice_CreateExternalResources
2.2.4.22XeDevice
2.2.4.22.1XeDevice_Create
2.2.4.22.2XeDevice_Stop
2.2.4.22.3XeDevice_Restart
2.2.4.22.4XeDevice_DrawLine
2.2.4.22.5XeDevice_DrawOutline
2.2.4.22.6XeDevice_DrawSolid
2.2.4.22.7XeDevice_CreateSurfacePool
2.2.4.22.8XeDevice_CreateVideoPool
2.2.4.22.9XeDevice_CreateLine
2.2.4.22.10XeDevice_CreateGradient
2.2.4.22.11XeDevice_DrawNotify
2.2.4.22.12XeDevice_EndVideoSurfaceAllocation
2.2.4.22.13XeDevice_BeginVideoSurfaceAllocation
2.2.4.22.14XeDevice_Enter3DMode
2.2.4.23HostWindow
2.2.4.23.1HostWindow_Create
2.2.4.23.2HostWindow_SetBackgroundColor
2.2.4.23.3HostWindow_SetPerspectiveSettings
2.2.4.23.4HostWindow_ChangeDataBits
2.2.4.23.5HostWindow_SetContent
2.2.4.23.6HostWindow_SetRoot
2.2.4.23.7HostWindow_SetCloseReason
2.2.4.24XAudSoundDevice
2.2.4.24.1XAudSoundDevice_Create
2.2.4.24.2XAudSoundDevice_CreateSound
2.2.4.24.3XAudSoundDevice_CreateSoundBuffer
2.2.4.24.4XAudSoundDevice_EvictExternalResources
2.2.4.24.5XAudSoundDevice_CreateExternalResources
2.2.4.24.6XAudSoundDevice_SetMute
2.2.4.24.7XAudSoundDevice_SetVolume
2.2.4.25Dx9Device
2.2.4.25.1Dx9Device_Stop
2.2.4.25.2Dx9Device_Restart
2.2.4.25.3Dx9Device_DrawLine
2.2.4.25.4Dx9Device_DrawOutline
2.2.4.25.5Dx9Device_DrawSolid
2.2.4.25.6Dx9Device_CreateSurfacePool
2.2.4.25.7Dx9Device_CreateVideoPool
2.2.4.25.8Dx9Device_CreateLine
2.2.4.25.9Dx9Device_CreateGradient
2.2.4.25.10Dx9Device_DrawNotify
2.2.4.25.11Dx9Device_EndVideoSurfaceAllocation
2.2.4.25.12Dx9Device_BeginVideoSurfaceAllocation
2.2.4.25.13Dx9Device_Enter3DMode
2.2.5Callback Messages
2.2.5.1LocalAnimationCallback_OnComplete
2.2.5.2LocalSoundBufferCallback_OnSoundBufferReady
2.2.5.3LocalSoundBufferCallback_OnSoundBufferLost
2.2.5.4LocalHostWindowCallback_OnRawExtenderInput
2.2.5.5LocalHostWindowCallback_OnEndKeyboardInput
2.2.5.6LocalHostWindowCallback_OnBeginKeyboardInput
2.2.5.7LocalRenderPortCallback_OnBatchProcessed
2.2.5.8LocalRenderPortCallback_OnPingReply
2.2.5.9LocalDataBufferCallback_OnComplete
2.2.5.10LocalDeviceCallback_OnSurfacePoolAllocation
2.2.5.11LocalDeviceCallback_OnLostDevice
2.2.5.12LocalDeviceCallback_OnCreated
2.2.6Common Structures
2.2.6.1BLOBREF
2.2.6.2Rotation
2.2.6.3Vector3
2.2.6.4Rectangle
2.2.6.5RectangleF
2.2.6.6Size
2.2.6.7ImageHeader
2.2.6.8Point
2.2.6.9Color
2.2.6.10ColorF
2.2.6.11SoundHeader
3Protocol Details
3.1Server Details (User Interface)
3.1.1Abstract Data Model
3.1.2Timers
3.1.3Initialization
3.1.4Higher-Layer Triggered Events
3.1.5Processing Events and Sequencing Rules
3.1.5.1Common Processing Rules
3.1.5.1.1Header Fields
3.1.5.1.2Error Handling
3.1.5.2DataBuffer
3.1.5.2.1Processing DataBuffer_RegisterOwner
3.1.5.3ContextRelay
3.1.5.3.1ContextRelay_Create
3.1.5.3.2ContextRelay_UnlinkContext
3.1.5.3.3ContextRelay_LinkContext
3.1.5.4Broker
3.1.5.4.1Broker_DestroyObject
3.1.5.4.2Broker_CreateObject
3.1.5.4.3Broker_CreateClass
3.1.5.5Context
3.1.5.5.1Context_ForwardMessage
3.1.5.5.2Context_DestroyGroup
3.1.5.5.3Context_CreateGroup
3.1.5.6RenderBuilder
3.1.5.6.1RenderBuilder_Create
3.1.5.6.2RenderBuilder_Clear
3.1.5.7Visual
3.1.5.7.1Visual_Create
3.1.5.7.2Visual_ChangeDataBits
3.1.5.7.3Visual_ChangeParent
3.1.5.7.4Visual_SetColor
3.1.5.7.5Visual_SetAlpha
3.1.5.7.6Visual_SetLayer
3.1.5.7.7Visual_SetRotation
3.1.5.7.8Visual_SetCenterPointScale
3.1.5.7.9Visual_SetCenterPointOffset
3.1.5.7.10Visual_SetScale
3.1.5.7.11Visual_SetSize
3.1.5.7.12Visual_SetPosition
3.1.5.7.13Visual_SetContent
3.1.5.7.14Visual_SetVisible
3.1.5.8AnimationManager
3.1.5.8.1AnimationManager_Create
3.1.5.8.2AnimationManager_BuildGradientColorMaskAnimation
3.1.5.8.3AnimationManager_BuildGradientOffsetAnimation
3.1.5.8.4AnimationManager_BuildRotationAnimation
3.1.5.8.5AnimationManager_BuildSizeAnimation
3.1.5.8.6AnimationManager_BuildScaleAnimation
3.1.5.8.7AnimationManager_BuildPositionAnimation
3.1.5.8.8AnimationManager_BuildColorAnimation
3.1.5.8.9AnimationManager_BuildAlphaAnimation
3.1.5.9WaitCursor
3.1.5.9.1WaitCursor_Create
3.1.5.9.2WaitCursor_Show
3.1.5.9.3WaitCursor_Hide
3.1.5.9.4WaitCursor_SetVisuals
3.1.5.9.5WaitCursor_SetShowAnimations
3.1.5.9.6WaitCursor_SetHideAnimations
3.1.5.10Device
3.1.5.10.1Device_Stop
3.1.5.10.2Device_Restart
3.1.5.10.3Device_DrawLine
3.1.5.10.4Device_DrawOutline
3.1.5.10.5Device_DrawSolid
3.1.5.10.6Device_CreateSurfacePool
3.1.5.11Window
3.1.5.11.1Window_SetBackgroundColor
3.1.5.11.2Window_SetPerspectiveSettings
3.1.5.11.3Window_ChangeDataBits
3.1.5.11.4Window_SetContent
3.1.5.11.5Window_SetRoot
3.1.5.12Surface
3.1.5.12.1Surface_DrawGrid
3.1.5.12.2Surface_Draw
3.1.5.12.3Surface_RemapContainer
3.1.5.12.4Surface_RemapLocation
3.1.5.12.5Surface_MarkContentValid
3.1.5.12.6Surface_Clear
3.1.5.12.7Surface_SetRotation
3.1.5.12.8Surface_SetStorageSize
3.1.5.13SurfacePool
3.1.5.13.1SurfacePool_Draw
3.1.5.13.2SurfacePool_CreateSurface
3.1.5.13.3SurfacePool_Free
3.1.5.13.4SurfacePool_Allocate
3.1.5.13.5SurfacePool_SetEmptyColor
3.1.5.13.6SurfacePool_SetPriority
3.1.5.14VideoPool
3.1.5.14.1VideoPool_Draw
3.1.5.14.2VideoPool_CreateSurface
3.1.5.14.3VideoPool_Free
3.1.5.14.4VideoPool_Allocate
3.1.5.14.5VideoPool_SetEmptyColor
3.1.5.14.6VideoPool_SetPriority
3.1.5.14.7VideoPool_SetContentOverscan
3.1.5.14.8VideoPool_NotifyVideoSizeChanged
3.1.5.15Rasterizer
3.1.5.15.1Rasterizer_LoadRawImage
3.1.5.16Gradient
3.1.5.16.1Gradient_Pop
3.1.5.16.2Gradient_Push
3.1.5.16.3Gradient_Draw
3.1.5.16.4Gradient_Clear
3.1.5.16.5Gradient_AddValue
3.1.5.16.6Gradient_SetOffset
3.1.5.16.7Gradient_SetColorMask
3.1.5.16.8Gradient_SetOrientation
3.1.5.17Line
3.1.5.17.1Line_SetThickness
3.1.5.17.2Line_SetColor
3.1.5.17.3Line_CommitLine
3.1.5.17.4Line_DrawPoint
3.1.5.18Animation
3.1.5.18.1Animation_AddCompletionLink
3.1.5.18.2Animation_SetEaseOut
3.1.5.18.3Animation_SetEaseIn
3.1.5.18.4Animation_SetBezier
3.1.5.18.5Animation_SetCosine
3.1.5.18.6Animation_SetSine
3.1.5.18.7Animation_SetSCurve
3.1.5.18.8Animation_SetLogarithmic
3.1.5.18.9Animation_SetLinear
3.1.5.18.10Animation_SetExponential
3.1.5.18.11Animation_SetDynamicRotation
3.1.5.18.12Animation_SetRotation
3.1.5.18.13Animation_SetColorF
3.1.5.18.14Animation_SetDynamicARGBColor
3.1.5.18.15Animation_SetDynamicRGBColor
3.1.5.18.16Animation_SetARGBColor
3.1.5.18.17Animation_SetRGBColor
3.1.5.18.18Animation_SetDynamicVector3
3.1.5.18.19Animation_SetVector3
3.1.5.18.20Animation_SetDynamicFloat
3.1.5.18.21Animation_SetFloat
3.1.5.18.22Animation_RemoveCallback
3.1.5.18.23Animation_AddCallback
3.1.5.18.24Animation_AddKeyframe
3.1.5.18.25Animation_Stop
3.1.5.18.26Animation_Play
3.1.5.18.27Animation_SetStopCommand
3.1.5.18.28Animation_SetAutoStop
3.1.5.18.29Animation_SetRepeatCount
3.1.5.18.30Animation_SetKeyframeTime
3.1.5.18.31Animation_SetKeyframeCount
3.1.5.19DynamicSurfaceFactory
3.1.5.19.1DynamicSurfaceFactory_CloseInstance
3.1.5.19.2DynamicSurfaceFactory_CreateVideoInstance
3.1.5.19.3DynamicSurfaceFactory_CreateSurfaceInstance
3.1.5.20SoundBuffer
3.1.5.20.1SoundBuffer_LoadSoundData
3.1.5.21Sound
3.1.5.21.1Sound_Stop
3.1.5.21.2Sound_Play
3.1.5.22SoundDevice
3.1.5.22.1SoundDevice_CreateSound
3.1.5.22.2SoundDevice_CreateSoundBuffer
3.1.5.22.3SoundDevice_EvictExternalResources
3.1.5.22.4SoundDevice_CreateExternalResources
3.1.5.23XeDevice
3.1.5.23.1XeDevice_Create
3.1.5.23.2XeDevice_Stop
3.1.5.23.3XeDevice_Restart
3.1.5.23.4XeDevice_DrawLine
3.1.5.23.5XeDevice_DrawOutline
3.1.5.23.6XeDevice_DrawSolid
3.1.5.23.7XeDevice_CreateSurfacePool
3.1.5.23.8XeDevice_CreateVideoPool
3.1.5.23.9XeDevice_CreateLine
3.1.5.23.10XeDevice_CreateGradient
3.1.5.23.11XeDevice_DrawNotify
3.1.5.23.12XeDevice_EndVideoSurfaceAllocation
3.1.5.23.13XeDevice_BeginVideoSurfaceAllocation
3.1.5.23.14XeDevice_Enter3DMode
3.1.5.24HostWindow
3.1.5.24.1HostWindow_Create
3.1.5.24.2HostWindow_SetBackgroundColor
3.1.5.24.3HostWindow_SetPerspectiveSettings
3.1.5.24.4HostWindow_ChangeDataBits
3.1.5.24.5HostWindow_SetContent
3.1.5.24.6HostWindow_SetRoot
3.1.5.24.7HostWindow_SetCloseReason
3.1.5.25XAudSoundDevice
3.1.5.25.1XAudSoundDevice_Create
3.1.5.25.2XAudSoundDevice_CreateSound
3.1.5.25.3XAudSoundDevice_CreateSoundBuffer
3.1.5.25.4XAudSoundDevice_EvictExternalResources
3.1.5.25.5XAudSoundDevice_CreateExternalResources
3.1.5.25.6XAudSoundDevice_SetMute
3.1.5.25.7XAudSoundDevice_SetVolume
3.1.5.26Dx9Device
3.1.5.26.1Dx9Device_Stop
3.1.5.26.2Dx9Device_Restart
3.1.5.26.3Dx9Device_DrawLine
3.1.5.26.4Dx9Device_DrawOutline
3.1.5.26.5Dx9Device_DrawSolid
3.1.5.26.6Dx9Device_CreateSurfacePool
3.1.5.26.7Dx9Device_CreateVideoPool
3.1.5.26.8Dx9Device_CreateLine
3.1.5.26.9Dx9Device_CreateGradient
3.1.5.26.10Dx9Device_DrawNotify
3.1.5.26.11Dx9Device_EndVideoSurfaceAllocation
3.1.5.26.12Dx9Device_BeginVideoSurfaceAllocation
3.1.5.26.13Dx9Device_Enter3DMode
3.1.5.27Callback Messages
3.1.5.27.1LocalAnimationCallback_OnComplete
3.1.5.27.2LocalSoundBufferCallback_OnSoundBufferReady
3.1.5.27.3LocalSoundBufferCallback_OnSoundBufferLost
3.1.5.27.4LocalHostWindowCallback_OnRawExtenderInput
3.1.5.27.5LocalHostWindowCallback_OnEndKeyboardInput
3.1.5.27.6LocalHostWindowCallback_OnBeginKeyboardInput
3.1.5.27.7LocalRenderPortCallback_OnBatchProcessed
3.1.5.27.8LocalRenderPortCallback_OnPingReply
3.1.5.27.9LocalDataBufferCallback_OnComplete
3.1.5.27.10LocalDeviceCallback_OnSurfacePoolAllocation
3.1.5.27.11LocalDeviceCallback_OnLostDevice
3.1.5.27.12LocalDeviceCallback_OnCreated
3.1.6Timer Events
3.1.7Other Local Events
3.2Client Details
3.2.1Abstract Data Model
3.2.1.1ContextID
3.2.1.2ObjectID
3.2.1.3TypeID
3.2.2Timers
3.2.3Initialization
3.2.4Higher-Layer Triggered Events
3.2.5Processing Events and Sequencing Rules
3.2.6Timer Events
3.2.7Other Local Events
4Protocol Examples
5Security
5.1Security Considerations for Implementers
6Appendix A: Product Behavior
7Change Tracking
8Index
1Introduction
The Remote Rendering Protocol Version 2, is a user interface system for applications in Windows Media Center, which is comprised of an application-side component model connected to a remote renderer by an asynchronous messaging system that enables the quick and easy construction of captivating interfaces.
Sections 1.8, 2, and 3 of this specification are normative and can contain the terms MAY, SHOULD, MUST, MUST NOT, and SHOULD NOT as defined in [RFC2119]. Sections 1.5 and 1.9 are also normative but do not contain those terms. All other sections and examples in this specification are informative.
1.1Glossary
The following terms are specific to this document:
ARGB: A color space wherein each color is represented as a quad (A, R, G, B), where A represents the alpha (transparency) component, R represents the red component, G represents the green component, and B represents the blue component. The ARGB value is typically stored as a 32-bit integer, wherein the alpha channel is stored in the highest 8 bits and the blue value is stored in the lowest 8 bits.
context: Logical container spaces where objects exist "together" in memory and can efficiently communicate with each other.
handle: A recipient of a message.
network byte order: The order in which the bytes of a multiple-byte number are transmitted on a network, most significant byte first (in big-endian storage). This may or may not match the order in which numbers are normally stored in memory for a particular processor.
renderer: A component that is responsible for receiving draw and animation commands, and rendering the scene to an output device.
MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.
1.2References
Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata.
1.2.1Normative References
We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information.
[MS-DSPA] Microsoft Corporation, "Device Session Property Access Protocol".
[MS-DTAG] Microsoft Corporation, "Device Trust Agreement Protocol".
[MS-RXAD] Microsoft Corporation, "Remote Experience Advertisement Protocol".
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997,
1.2.2Informative References
None.
1.3Protocol Overview (Synopsis)
The Remote Rendering Protocol Version 2 enables the creation of interfaces in a remote renderer through an asynchronous messaging system. The application-side component model (server) connected to the remote renderer (client) can be deployed within a single process, across multiple processes, or across multiple computers on a network over a reliable point-to-point connection.
Figure 1: Point-to-point connection
1.3.1User Experience
The Remote Rendering Protocol Version 2 component model defines a basic programming model and several reusable services for various user interface (UI) tasks, hereafter referred to as the "user experience". The primary logic runs in process with the client application, which isolates the developer from the more complex implementation details of rendering and asynchronous communication.
1.3.1.1Internal Componentization
The messages shared through the messaging system are contained within the following components/classes. The server provides the appropriate information to the client before the messages can be executed.
Figure 2: Components
The following components make up the remaining implementation of the Remote Rendering Protocol Version 2 component model.
1.3.2Rendering Engine
Remote Rendering Protocol Version 2 is designed to work with a mid-level application compositing rendering engine that can operate independently of the application and is driven by a stream of asynchronous rendering commands that describe the scenes to be displayed. The renderer has to be capable of running autonomously for significant periods of time in the absence of new commands from the application.
1.3.2.1Addressing Mechanism
An internal addressing mechanism for delivering messages to objects is layered over the transport.
This mechanism is encompassed by:
- Contexts, which are logical container spaces where objects exist "together" in memory and can efficiently communicate with each other.
- A handle, which specifies the recipients of the message because all messages are addressed to some endpoint with a specific handle.
Both class and instance handles are valid. A message to a class handle is called a "static message". A message to an instance handle is called an "instance message".
1.3.3Message Sequence
The following messages are sent during the lifetime of a given remote service. The legend below describes the sequence these messages use during the service.
The messages that could take place during the session are those that depend on the implementation (what the user interface communicates to the renderer); therefore, these messages are not necessarily present during a specific session. The messages that are present during the session are those that encompass Remote Rendering Protocol Version 2.
Figure 3: Message sequence
1.4Relationship to Other Protocols
The Remote Rendering Protocol Version 2 is not a standalone protocol. It depends on an established connection between the server and the client, which is covered in [MS-DTAG] Device Trust Agreement and [MS-RXAD] Remoted Experience Advertisement.
1.5Prerequisites/Preconditions
Other than the relationship called out in the previous section:
- Communication to the device has to have been established.
- The server capabilities (graphics, memory, and so on) have to be identified and the information has to be provided to Remote Rendering Protocol Version 2 by the Device Session Property Access Protocol.
1.6Applicability Statement
Remote Rendering Protocol Version 2 is applicable to environments that require the ability to send rendering instructions over a reliable and pre-established connection to a remote renderer.
1.7Versioning and Capability Negotiation
Remote Rendering Protocol Version 2 does not handle versioning and capabilities directly; instead, they are taken care of by the Device Session Property Access Protocol because Remote Rendering Protocol Version 2 is carried over this protocol. For further information please refer to section 1.6 of [MS-DSPA].
1.8Vendor-Extensible Fields
None
1.9Standards Assignments
None
2Messages
2.1Transport
Remote Rendering Protocol Version 2 is transport agnostic and can be carried over any reliable transport.
2.2Message Syntax
2.2.1Initialization Messages (Handshake)
Upon establishing a transport connection, the client sends a RemoteClientInformation message, as specified in section 2.2.1.1. Next, the server sends a RemoteServerInformation message, as specified in section 2.2.1.2.
Initialization messages are sent in network byte order.
2.2.1.1RemoteClientInformation message
The RemoteClientInformation message is used to send the client's information that is required for initialization to the server.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
cbSize
dwVersion
dwMagic
cbSize (4 bytes): An unsigned 32-bit integer. The size of the message.
dwVersion (4 bytes): An unsigned 32-bit integer. The client MUST be set this field to 0x00010006. The version of the client's network pipe.
dwMagic (4 bytes): An unsigned 32-bit integer. The client MUST set this field to 0x19740721. A number used to identify the protocol family of the client.
2.2.1.2RemoteServerInformation message
The RemoteServerInformation message sends information about the server to the client.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
cbSize
dwVersion
dwMagic
idContextApplication
idContextRender
dwReserved1
cItemsPerGroupBits
cGroupBits
idObjectBrokerClass
cbSize (4 bytes): An unsigned 32-bit integer. The size of the message.
dwVersion (4 bytes): An unsigned 32-bit integer. The client MUST be set this field to 0x00010006. The version of the server's network pipe.
dwMagic (4 bytes): An unsigned 32-bit integer. The client MUST be set this field to 0x19740721. A number used to identify the protocol family of the server.
idContextApplication (4 bytes): An unsigned 32-bit integer. Contains the context ID of the server.
idContextRender (4 bytes): An unsigned 32-bit integer. Contains the context ID to which the receiving client is being assigned.
dwReserved1 (4 bytes): An unsigned 32-bit integer. Unused and MUST be set to zero.
cItemsPerGroupBits (4 bytes): A signed 32-bit integer. Specifies how many bits in the handle are used for object indices within a group.
cGroupBits (4 bytes): A signed 32-bit integer. Specifies how many bits in the handle are used for "groups" of objects.
idObjectBrokerClass (4 bytes): An unsigned 32-bit integer. A predefined handle to the "broker" class.
2.2.2Command Messages
Once the handshake is completed, the connection is open for either client or server to send commands. There are two types of commands that can be sent: buffer commands and shutdown commands.
Command messages are sent in network byte order.
2.2.2.1Command Message
A command message is used to signal that either a buffer and payload are following, or that the endpoint has to shut down.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
nCommandType
nCommandType (4 bytes): An unsigned 32-bit integer. The type of command to follow.
Defined types are described in the following table.
Value / Description0x00000001 / Buffer: Followed by a buffer information header and associated buffer payload.
0x00000002 / Shutdown: Last message sent. Endpoint will no longer communicate.
2.2.3Framing Messages
If a command message is sent as a buffer command type, it is followed by a sequence of messages, starting with a BufferInfo message.
Framing messages are sent in network byte order.
2.2.3.1BufferInfo Message
Sends information about the message to follow.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
idContextSrc
idContextDest
idBuffer
nFlags
cbSizeBuffer
idContextSrc (4 bytes): An unsigned 32-bit integer. Contains the unique context ID of the sender.
idContextDest (4 bytes): An unsigned 32-bit integer. Contains the unique context ID of the recipient.
idBuffer (4 bytes): An unsigned 32-bit integer. Contains the unique ID for the buffer, which can be any of the following:
- Data Buffer: The buffer has a non-null ObjectID (idBuffer) and the memory can be associated with a new DataBuffer instance bearing this handle. No broker creation sequence will precede this transaction; the DataBuffer instance is created implicitly when the data is received.
- Individual Message Buffer: The buffer has a NULL ObjectID (idBuffer) and the IsBatch flag will be cleared. The payload can be interpreted as a single message and processed.
- Batch Message Buffer: The buffer has a NULL ObjectID (idBuffer) and the IsBatch flag will be SET. The payload can be interpreted as a batch with multiple messages and processed in order.
nFlags (4 bytes): An unsigned 32-bit integer. Describes the BufferFlags.
Value / Description0x00000001 / IsBatch. The Buffer is a batch of messages.
All other flags are reserved, MUST be ignored, and MUST never be specified.
cbSizeBuffer (4 bytes): An unsigned 32-bit integer. The size of the buffer's data.
2.2.3.2MessageBatch Message
If the BufferInfo message's ObjectID is NULL and IsBatch flag is set, the next message is a MessageBatch.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
idPredicateBuffer
uOffsetFirstEntry
idPredicateBuffer (4 bytes): An unsigned 32-bit integer. This is the ID of the previously sent buffer that MUST be processed before this one.
If idPredicateBuffer is not 0x00000000, this refers to a previously transmitted data buffer that can be processed as a batch buffer prior to processing this message. That buffer can also refer to another predicate buffer (and so on).
If idPredicateBuffer is 0x00000000, the following message entries will be processed.
uOffsetFirstEntry (4 bytes): An unsigned 32-bit integer. The size of the buffer offset of the first message entry.
2.2.3.3MessageBatchEntry Message
A message batch can contain one or more message entries, which are identified by the following header:
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
uOffsetNextEntry
uOffsetNextEntry (4 bytes): An unsigned 32-bit integer. This is the size of the buffer offset of the next message entry. The final entry in a batch has a uOffsetNextEntry of 0x00000000.
2.2.4Payload Messages
Payload messages are used to issue rendering and sound commands. Payload messages are sent in client-byte order, as determined by the extender capabilities exchange.
Every payload message has the standard header listed in the following table.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
_size
_msgid
_idObjectSubject
_size (4 bytes): An unsigned 32-bit integer. Describes the total message size, in bytes.
_msgid (4 bytes): A signed 32-bit integer. The message ID that is unique to the specific target. The value specified in _msgid is used to indicate which action to take on the target object.
_idObjectSubject (4 bytes): An unsigned 32-bit integer. The ID of the target object. The _idObjectSubject refers to an object that was previously created by sending a Broker_CreateObject payload.
2.2.4.1DataBuffer
2.2.4.1.1DataBuffer_RegisterOwner
The DataBuffer_RegisterOwner message registers the owner of the buffer. The owner is notified when the buffer usage is complete, which allows the owner to reclaim resources.
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 10 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 2
0 / 1 / 2 / 3 / 4 / 5 / 6 / 7 / 8 / 9 / 3
0 / 1
_size
_msgid
_idObjectSubject
_objcb
_ctxcb
_size (4 bytes): An unsigned 32-bit integer. Describes the total message size, in bytes.
_msgid (4 bytes): A signed 32-bit integer. The message ID that is unique to the specific target. The _msgid value is 0x00000000 for this message.
_idObjectSubject (4 bytes): An unsigned 32-bit integer. The ID of the target object.