Update Publishing Point Settings

The Update Publishing Point Settings operation updates the settings for an existing publishing point.

When site global configurations (such as the archiving path) are specified, they are stored in the SMIL manifest for the specified publishing point. Properties cannot be changed after the publishing point is started.

Restrictions

Note

Publishing point state must be Idle before you can update publishing point settings.

Publishing point state after successful operation

Idle. This operation does not change the publishing point state.

Request

The Update Publishing Point Settings request may be specified as follows:

Method

URI

PUT

http(s)://<hostname>/<filepath>/settings

URI Parameters

The following table lists URL template segments and parameters.

Parameter

Description

Example

hostname

The host name.

Contoso.com

filepath

The path of the publishing point file.

testBunny.isml

Request Headers

The following table describes required and optional request headers.

Request Header

Description

Format

Content-Type

The content-type must be set to applications/atom+xml

Content-Type: application/atom+xml

Request Body

The following example shows the format of the request body. For information of element values and attribute values, see SmoothStreaming Schema Reference.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
  <id>unique-ID</id>
  <title>title</title>
  <updated>time-stamp</updated>
  <link href="http(s)://host-name/.isml-file-path/settings" rel="self" type="application/atom+xml" title="Settings" />
  <link href="http(s)://host-name/.isml-file-path/state" rel="related" type="application/atom+xml" title="State" />
  <content type="application/xml">
    <SmoothStreaming xmlns="http://schemas.microsoft.com/iis/media/2011/03/streaming/management">
      <Settings>
        <Title>title</Title>
        <SourceType>Push</SourceType>
        <AutoStart>true|false</AutoStart>
        <AutoRestartOnEncoderReconnect>true|false</AutoRestartOnEncoderReconnect>
        <LookAheadChunks>number-of-look-ahead-chunks</LookAheadChunks>
        <Archive enabled="true|false">
          <Path useEventIdOnPath="true|false" />
        </Archive>
        <ClientConnections enabled="true|false">
          <ClientManifestVersion>client-manifest-version-number</ClientManifestVersion>
        </ClientConnections>
        <ServerConnections enabled="true|false">
          <SendEndOfStreamOnStop>true|false</SendEndOfStreamOnStop>
        </ServerConnections>
        <Modules>
          <Module id="ID" type="sink|source" name="name">
            <HLS>
              <SegmentLength>segment-length</SegmentLength>
              <MaxBitRate>maximum-bit-rate</MaxBitRate>
              <AllowCaching>true|false</AllowCaching>
              <BackwardCompatible>true|false</BackwardCompatible>
              <IncludeCodecs>true|false</IncludeCodecs>
              <Encryption enabled="true">
                <Key>Encryption-Key</Key>
              </Encryption>
              <Encryption enabled="true|false" />
            </HLS>
          </Module>
        </Modules>
      </Settings>
    </SmoothStreaming>
  </content>
</entry>

The following example shows a request body.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
  <id>http://contoso.com/media/bunny.isml/settings</id>
  <title>Bunny</title>
  <updated>2011-05-31T21:32:26Z</updated>
  <link href="http://contoso.com/media/bunny.isml/settings" rel="self" type="application/atom+xml" title="Settings" />
  <link href="http://contoso.com/media/bunny.isml/state" rel="related" type="application/atom+xml" title="State" />
  <content type="application/xml">
    <SmoothStreaming xmlns="http://schemas.microsoft.com/iis/media/2011/03/streaming/management">
      <Settings>
        <Title>Bunny</Title>
        <SourceType>Push</SourceType>
        <AutoStart>false</AutoStart>
        <AutoRestartOnEncoderReconnect>false</AutoRestartOnEncoderReconnect>
        <LookAheadChunks>2</LookAheadChunks>
        <Archive enabled="true">
          <Path useEventIdOnPath="false" />
        </Archive>
        <ClientConnections enabled="true">
          <ClientManifestVersion>2.0</ClientManifestVersion>
        </ClientConnections>
        <ServerConnections enabled="true">
          <SendEndOfStreamOnStop>true</SendEndOfStreamOnStop>
        </ServerConnections>
         <Modules>
          <Module id="hls" type="sink" name="HTTP Live Streaming">
            <HLS>
              <SegmentLength>PT10S</SegmentLength>
              <MaxBitRate>3000000</MaxBitRate>
              <AllowCaching>false</AllowCaching>
              <BackwardCompatible>true</BackwardCompatible>
              <IncludeCodecs>false</IncludeCodecs>
              <Encryption enabled="true">
                <Key>8C339AD2F44E4B2B72C95888385221BE</Key>
              </Encryption>
            </HLS>
          </Module>
        </Modules>
      </Settings>
    </SmoothStreaming>
  </content>
</entry>

Response

The response is an HTTP status code.

Status Code

A successful operation returns status code 200 (OK). For more information about error status codes, see Service Management Status and Error Codes.

Response Body

None.

Authorization

The authenticated user must have write access to the .isml file.