POST api/Broadpeak?overrideKeyIds={overrideKeyIds}

CPIX key exchange protocol implementation for Broadpeak Packager BkS350.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
overrideKeyIds

Overrides key IDs in the request with customer-derivable key IDs.

boolean

Default value is False

Body Parameters

None.

Request Formats

application/xml

Sample:
<?xml version="1.0" ?>
<cpix:CPIX contentId="live_channel_01" xmlns:cpix="urn:dashif:org:cpix">
	<cpix:ContentKeyList>
		<cpix:ContentKey kid="bd0686fb-5fcf-5eec-8d08-69e313ea0443"/>
		<cpix:ContentKey kid="b2ac4820-30ed-591e-b292-9f73a5213657"/>
		<cpix:ContentKey kid="32687410-4337-5201-b284-970e4d9a1d6f"/>
	</cpix:ContentKeyList>
	<cpix:DRMSystemList>
		<cpix:DRMSystem kid="bd0686fb-5fcf-5eec-8d08-69e313ea0443" systemId="94CE86FB-07FF-4F43-ADB8-93D2FA968CA2"/>
		<cpix:DRMSystem kid="b2ac4820-30ed-591e-b292-9f73a5213657" systemId="94CE86FB-07FF-4F43-ADB8-93D2FA968CA2"/>
		<cpix:DRMSystem kid="32687410-4337-5201-b284-970e4d9a1d6f" systemId="94CE86FB-07FF-4F43-ADB8-93D2FA968CA2"/>
	</cpix:DRMSystemList>
	<cpix:ContentKeyPeriodList>
		<cpix:ContentKeyPeriod end="2020-12-17T16:55:00Z" id="keyperiod_1608224040" start="2020-12-17T16:54:00Z"/>
	</cpix:ContentKeyPeriodList>
	<cpix:ContentKeyUsageRuleList>
		<cpix:ContentKeyUsageRule intendedTrackType="audio" kid="bd0686fb-5fcf-5eec-8d08-69e313ea0443">
			<cpix:KeyPeriodFilter periodId="keyperiod_1608224040"/>
			<cpix:AudioFilter/>
		</cpix:ContentKeyUsageRule>
		<cpix:ContentKeyUsageRule intendedTrackType="lowres" kid="b2ac4820-30ed-591e-b292-9f73a5213657">
			<cpix:KeyPeriodFilter periodId="keyperiod_1608224040"/>
			<cpix:VideoFilter maxPixels="414719" minPixels="0"/>
		</cpix:ContentKeyUsageRule>
		<cpix:ContentKeyUsageRule intendedTrackType="highres" kid="32687410-4337-5201-b284-970e4d9a1d6f">
			<cpix:KeyPeriodFilter periodId="keyperiod_1608224040"/>
			<cpix:VideoFilter minPixels="414720"/>
		</cpix:ContentKeyUsageRule>
	</cpix:ContentKeyUsageRuleList>
</cpix:CPIX>

Response Information

Resource Description

None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • OK (200) - CPIX was successfully generated.
  • BadRequest (400) - CPIX generation failed due to invalid input data.

Response Formats

application/xml

Sample:
<?xml version="1.0" encoding="utf-8"?>
<cpix:CPIX contentId="live_channel_01" xmlns:cpix="urn:dashif:org:cpix">
  <cpix:ContentKeyList>
    <cpix:ContentKey kid="bd0686fb-5fcf-5eec-8d08-69e313ea0443" explicitIV="7U6bOb+cXUAas5E4/T8Sag==" commonEncryptionScheme="cbcs">
      <cpix:Data>
        <Secret xmlns="urn:ietf:params:xml:ns:keyprov:pskc">
          <PlainValue>T9Mv7WqAzTgbYvJPkYJsOA==</PlainValue>
        </Secret>
      </cpix:Data>
    </cpix:ContentKey>
    <cpix:ContentKey kid="b2ac4820-30ed-591e-b292-9f73a5213657" explicitIV="yqPa3Wle5tQAvpeLK9OyvQ==" commonEncryptionScheme="cbcs">
      <cpix:Data>
        <Secret xmlns="urn:ietf:params:xml:ns:keyprov:pskc">
          <PlainValue>t1Ukdn4FW9kDK7RxYejcnw==</PlainValue>
        </Secret>
      </cpix:Data>
    </cpix:ContentKey>
    <cpix:ContentKey kid="32687410-4337-5201-b284-970e4d9a1d6f" explicitIV="8fxVE33/H9Xl5Q73Jj/6Hg==" commonEncryptionScheme="cbcs">
      <cpix:Data>
        <Secret xmlns="urn:ietf:params:xml:ns:keyprov:pskc">
          <PlainValue>56AP4avjzV5z/m3mBGv4Qg==</PlainValue>
        </Secret>
      </cpix:Data>
    </cpix:ContentKey>
  </cpix:ContentKeyList>
  <cpix:DRMSystemList>
    <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="bd0686fb-5fcf-5eec-8d08-69e313ea0443">
      <cpix:HLSSignalingData playlist="master">I0VYVC1YLVNFU1NJT04tS0VZOk1FVEhPRD1TQU1QTEUtQUVTLFVSST0ic2tkOi8vYmQwNjg2ZmItNWZjZi01ZWVjLThkMDgtNjllMzEzZWEwNDQzOkVENEU5QjM5QkY5QzVENDAxQUIzOTEzOEZEM0YxMjZBIixLRVlGT1JNQVQ9ImNvbS5hcHBsZS5zdHJlYW1pbmdrZXlkZWxpdmVyeSIsS0VZRk9STUFUVkVSU0lPTlM9IjEi</cpix:HLSSignalingData>
      <cpix:HLSSignalingData playlist="media">I0VYVC1YLUtFWTpNRVRIT0Q9U0FNUExFLUFFUyxVUkk9InNrZDovL2JkMDY4NmZiLTVmY2YtNWVlYy04ZDA4LTY5ZTMxM2VhMDQ0MzpFRDRFOUIzOUJGOUM1RDQwMUFCMzkxMzhGRDNGMTI2QSIsS0VZRk9STUFUPSJjb20uYXBwbGUuc3RyZWFtaW5na2V5ZGVsaXZlcnkiLEtFWUZPUk1BVFZFUlNJT05TPSIxIg==</cpix:HLSSignalingData>
    </cpix:DRMSystem>
    <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="b2ac4820-30ed-591e-b292-9f73a5213657">
      <cpix:HLSSignalingData playlist="master">I0VYVC1YLVNFU1NJT04tS0VZOk1FVEhPRD1TQU1QTEUtQUVTLFVSST0ic2tkOi8vYjJhYzQ4MjAtMzBlZC01OTFlLWIyOTItOWY3M2E1MjEzNjU3OkNBQTNEQURENjk1RUU2RDQwMEJFOTc4QjJCRDNCMkJEIixLRVlGT1JNQVQ9ImNvbS5hcHBsZS5zdHJlYW1pbmdrZXlkZWxpdmVyeSIsS0VZRk9STUFUVkVSU0lPTlM9IjEi</cpix:HLSSignalingData>
      <cpix:HLSSignalingData playlist="media">I0VYVC1YLUtFWTpNRVRIT0Q9U0FNUExFLUFFUyxVUkk9InNrZDovL2IyYWM0ODIwLTMwZWQtNTkxZS1iMjkyLTlmNzNhNTIxMzY1NzpDQUEzREFERDY5NUVFNkQ0MDBCRTk3OEIyQkQzQjJCRCIsS0VZRk9STUFUPSJjb20uYXBwbGUuc3RyZWFtaW5na2V5ZGVsaXZlcnkiLEtFWUZPUk1BVFZFUlNJT05TPSIxIg==</cpix:HLSSignalingData>
    </cpix:DRMSystem>
    <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="32687410-4337-5201-b284-970e4d9a1d6f">
      <cpix:HLSSignalingData playlist="master">I0VYVC1YLVNFU1NJT04tS0VZOk1FVEhPRD1TQU1QTEUtQUVTLFVSST0ic2tkOi8vMzI2ODc0MTAtNDMzNy01MjAxLWIyODQtOTcwZTRkOWExZDZmOkYxRkM1NTEzN0RGRjFGRDVFNUU1MEVGNzI2M0ZGQTFFIixLRVlGT1JNQVQ9ImNvbS5hcHBsZS5zdHJlYW1pbmdrZXlkZWxpdmVyeSIsS0VZRk9STUFUVkVSU0lPTlM9IjEi</cpix:HLSSignalingData>
      <cpix:HLSSignalingData playlist="media">I0VYVC1YLUtFWTpNRVRIT0Q9U0FNUExFLUFFUyxVUkk9InNrZDovLzMyNjg3NDEwLTQzMzctNTIwMS1iMjg0LTk3MGU0ZDlhMWQ2ZjpGMUZDNTUxMzdERkYxRkQ1RTVFNTBFRjcyNjNGRkExRSIsS0VZRk9STUFUPSJjb20uYXBwbGUuc3RyZWFtaW5na2V5ZGVsaXZlcnkiLEtFWUZPUk1BVFZFUlNJT05TPSIxIg==</cpix:HLSSignalingData>
    </cpix:DRMSystem>
  </cpix:DRMSystemList>
  <cpix:ContentKeyPeriodList>
    <cpix:ContentKeyPeriod end="2020-12-17T16:55:00Z" id="keyperiod_1608224040" start="2020-12-17T16:54:00Z" />
  </cpix:ContentKeyPeriodList>
  <cpix:ContentKeyUsageRuleList>
    <cpix:ContentKeyUsageRule kid="bd0686fb-5fcf-5eec-8d08-69e313ea0443" intendedTrackType="audio">
      <cpix:KeyPeriodFilter periodId="keyperiod_1608224040" />
      <cpix:AudioFilter />
    </cpix:ContentKeyUsageRule>
    <cpix:ContentKeyUsageRule kid="b2ac4820-30ed-591e-b292-9f73a5213657" intendedTrackType="lowres">
      <cpix:KeyPeriodFilter periodId="keyperiod_1608224040" />
      <cpix:VideoFilter minPixels="0" maxPixels="414719" />
    </cpix:ContentKeyUsageRule>
    <cpix:ContentKeyUsageRule kid="32687410-4337-5201-b284-970e4d9a1d6f" intendedTrackType="highres">
      <cpix:KeyPeriodFilter periodId="keyperiod_1608224040" />
      <cpix:VideoFilter minPixels="414720" />
    </cpix:ContentKeyUsageRule>
  </cpix:ContentKeyUsageRuleList>
</cpix:CPIX>