This section includes a list of SOAP Service Messages available including their arguments and return values.

GetSessions

asfx:SubscriptionResourceType Subscribe( xsd:string SessionID, asfx:EndpointReferenceType SubscriptionObserver, asfx:EndpointReferenceType SessionObserver, asfx:TopicExpressionType Topics, xsd:unsignedInt Duration )

Subscribes to a FASP session. If the argument SessionID is set to 0, a subscription to all FASP sessions will be established.

Parameters

  • SessionID: An identifier of the FASP session being subscribed to.
  • SubscriptionObserver: A reference to a web services endpoint that will receive subscription notifications.
  • SessionObserver: A reference to a web services endpoint that will receive session notifications.
  • Topics: A list of topics being subscribed to.
  • Duration: Duration, in seconds, before the subscription will expire.

Return

  • A subscription resource.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#Subscribe

UpdateSubscription

asfx:SubscriptionResourceType UpdateSubscription( xsd:string SubscriptionID, asfx:TopicExpressionType Topics, xsd:unsignedInt Duration )

Updates an existing subscription. The list of topics specified by Topics will be added to any topics currently associated with the subscription. The time specified by Duration will establish a new expiration date for the subscription. A subscription can be updated to an earlier or later expiration date.

Parameters

  • SubscriptionID: An identifier of the subscription being updated.
  • Topics: A list of topics to add to the subscription.
  • Duration: Duration, in seconds, before the subscription will expire.

Return

  • A subscription resource.

Faults

  • asf:SubscriptionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#UpdateSubscription

Unsubscribe

asfx:SubscriptionResourceType Unsubscribe( xsd:string SubscriptionID, asfx:TopicExpressionType Topics )

Updates an existing subscription. The list of topics specified by Topics will be removed from the subscription. If, after the topics have been removed, no topics remain in the subscription, the subscription will be terminated.

Parameters

  • SubscriptionID: An identifier of the subscription being unsubscribed from.
  • Topics: A list of topics being removed from the subscription.

Return

  • A subscription resource.

Faults

  • asf:SubscriptionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#Unsubscribe

ListSessions

ArrayOf xsd:string ListSessions()

List the active FASP sessions.

Return

  • An array of session IDs.

SOAP Action

  • FASPSessionNET-200601#ListSessions

QuerySession

asfx:SessionType QuerySession( xsd:string SessionID )

Returns information about an active FASP session.

Parameters

  • SessionID: An identifier of the FASP session being queried.

Return

  • A FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#QuerySession

SetRateParameters

void SetRateParameters( xsd:string SessionID, asfx:RateParametersType RateParameters )

Sets the rate parameters of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • RateParameters: Rate parameters to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetRateParameters

SetPolicy

void SetPolicy( xsd:string SessionID, xsd:string Policy )

Sets the rate parameters of a FASP session. Valid values for the Policy argument are Fixed, Fair, and Trickle.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • Policy: Rate policy to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetPolicy

SetTargetRate

void SetTargetRate( xsd:string SessionID, xsd:unsignedInt TargetRate )

Sets the rate parameters of a FASP session. Valid values for the Policy argument are Fixed, Fair, and Trickle.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • TargetRate: Target rate, in Kbps, to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetTargetRate

SetMinimumRate

void SetMinimumRate( xsd:string SessionID, xsd:unsignedInt MinimumRate )

Sets the minimum rate of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • MinimumRate: Minimum rate, in Kbps, to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetMinimumRate

SetBandwidthCap

void SetBandwidthCap( xsd:string SessionID, xsd:unsignedInt BandwidthCap )

Sets the bandwidth cap of a FASP session.

Parameters

  • SessionID: An identifier of the FASP session being modified.
  • BandwidthCap: Bandwidth cap, in Kbps, to assign to the FASP session.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#SetBandwidthCap

Cancel

void Cancel( xsd:string SessionID )

Cancels a FASP session.

Parameters

  • SessionID: An identifier of the FASP session to cancel.

Faults

  • asf:SessionNotFoundFault

SOAP Action

  • FASPSessionNET-200601#Cancel
Video player

Video

×