IWMSPublishingPoint.WrapperPath (Visual Basic .NET)

The WrapperPath property specifies and retrieves the path to a wrapper playlist file.

IWMSPublishingPoint.WrapperPath = String
String = IWMSPublishingPoint.WrapperPath

Property Value

A String containing the playlist.

If this property fails, it returns an error number.

Number	Description
0x8007000E	There is insufficient memory to complete the function.
0x000000A1	String does not reference a file with a valid playlist extension.
0xC00D145AL	The publishing point was already removed.
0xC00D1452L	The method is not supported for cache proxy publishing points.

Remarks

This method is not supported for cache proxy publishing points.

A wrapper playlist can contain references to media files that are streamed before and after the content requested by the client. Hence, the media files wrap the requested content. You can use a wrapper playlist to guarantee that every client connected to a publishing point renders specific content. In the following wrapper playlist example, media content is inserted before and after the requested content indicated by the "%url%" placeholder:

<seq>
     <media src = "c:\wmpub\wmroot\content1.wmv"
     <media src = "%url%"
     <media src = "c:\wmpub\wmroot\content2.wmv"
</seq>

Example

Imports Microsoft.WindowsMediaServices.Interop
Imports System.Runtime.InteropServices

Private Sub GetSetWrapperPath()

    ' Declare variables.
    Dim Server As WMSServer
    Dim PubPoints As IWMSPublishingPoints
    Dim PubPoint As IWMSPublishingPoint
    Dim strText As String

Try
    ' Create the WMSServer object.
    Server = New WMSServer()

    ' Retrieve the IWMSPublishingPoints object.
    PubPoints = Server.PublishingPoints

    ' Retrieve information about each publishing point.
    For Each PubPoint In PubPoints

        ' Retrieve the path to the wrapper playlist.
        strText = PubPoint.WrapperPath

        ' Set the path to the wrapper playlist.
        strText = "c:\wmpub\wmroot\wrapper.wsx"
        PubPoint.WrapperPath = strText

    Next

Catch excCom As COMException
    ' TODO: Handle COM exceptions.
Catch exc As Exception
    ' TODO: Handle errors.
Finally
    ' TODO: Clean-up code goes here.
End Try

End Sub

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also

Reference

IWMSPublishingPoint Object (Visual Basic .NET)

IWMSPublishingPoint.EnableWrapperPath (Visual Basic .NET)