Broadpeak.io SDK

Package

To use the sdk in your application, you need to include the package: "github.com/broadpeak-io/go-sdk"

Initializing the Broadpeak object

The main object of the SDK is broadpeakio. The Broadpeak object can be initialized using the below code:

broadpeak := broadpeakio.MakeClient(apiKey)

API key: You can get the API key from account settings > API keys.

How to use the SDK

Once you add the broadpeakio package and instantiate the broadpeak object you can call the methods of your choice by referencing those methods using the broadpeak object. For example:

response, error := broadpeak.GetAllSources(0,0)

Following are the methods defined in the SDK with their required parameters and the expected response from the API call.

Sources

GetAllSources

Method Call

response, err := broadpeak.GetAllSources(offset, limit)

Parameters

Parameters	Type	Definition
Offset	uint	Offset of the first result to return
Limit	uint	Maximum number of results to return

Response

The response will be of the type []SourceOutput

Type SourceOutput is defined as:

{
    Id     uint   `json:"id"`
    Name   string `json:"name"`
    Url    string `json:"url"`
    Type   string `json:"type"`
    Format string `json:"format"`
}

GetSource

Method Call

response, err = broadpeak.CheckSourceStatus(sourceType, sourceUrl)

Parameters

Parameters	Type	Definition
sourceType	string	Type of the source to be checked (live, asset...)
sourceUrl	string	URL of the source to be checked

Response

The response will be of the type SourceStatusOutput

Type SourceStatusOutput is defined as:

{
    MessageText   string `json:"messageText"`
    SeverityLEvel string `json:"severityLevel"`
}

Sources/Live

CreateLiveSource

Method Call

response, err := broadpeak.CreateLiveSource(options)

Parameters

Parameters	Type	Definition
options	LiveSource	{ Name string `json:"name,omitempty"` //required Url string `json:"url,omitempty"` //required Description string `json:"description,omitempty"` BackupIp string `json:"backupIp,omitempty"` }

Response

The response will be of the type LiveOutput

Type LiveOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

GetLiveSource

Method Call

response, err = broadpeak.GetLiveSource(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the live source assigned by broadpeak.io

Response

The response will be of the type LiveOutput

Type LiveOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

UpdateLiveSource

Method Call

response, err = broadpeak.UpdateLiveSource(Id, updateOptions)

Parameters

Parameters	Type	Definition
id	uint	Id of the live source assigned by broadpeak.io
updateOptions	LiveSource	{ Name string `json:"name,omitempty"` //required Url string `json:"url,omitempty"` //required Description string `json:"description,omitempty"` BackupIp string `json:"backupIp,omitempty"` }

Response

The response will be of the type LiveOutput

Type LiveOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

DeleteLiveSource

Method Call

response, err = broadpeak.DeleteLiveSource(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the live source assigned by broadpeak.io

Response

The response will be of the type LiveOutput

Type LiveOutput is defined as:

{
    Name        string `json:"name"`
    Description string `json:"description"`
    Url         string `json:"url"`
    BackupIp    string `json:"backupIp"`
    Format      string `json:"format"`
    Id          uint   `json:"id"`
}

Sources/Asset

CreateAsset

Method Call

response, err := broadpeak.CreateAsset(options)

Parameters

Parameters	Type	Definition
options	Asset	{ Name string `json:"name,omitempty"` //required Url string `json:"url,omitempty"` //required Description string `json:"description,omitempty"` BackupIp string `json:"backupIp,omitempty"` }

Response

The response will be of the type AssetOutput

Type AssetOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

GetAsset

Method Call

response, err = broadpeak.GetAsset(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the asset source assigned by broadpeak.io

Response

The response will be of the type AssetOutput

Type AssetOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

UpdateAsset

Method Call

response, err = broadpeak.UpdateAsset(Id, updateOptions)

Parameters

Parameters	Type	Definition
id	uint	Id of the asset source assigned by broadpeak.io
updateOptions	Asset	{ Name string `json:"name,omitempty"` //required Url string `json:"url,omitempty"` //required Description string `json:"description,omitempty"` BackupIp string `json:"backupIp,omitempty"` }

Response

The response will be of the type AssetOutput

Type AssetOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

DeleteAsset

Method Call

response, err = broadpeak.DeleteAsset(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the asset source assigned by broadpeak.io

Response

The response will be of the type AssetOutput

Type AssetOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	Format      string `json:"format"`
	Id          uint   `json:"id"`
}

Sources/AssetCatalog

CreateAssetCatalog

Method Call

response, err := broadpeak.CreateAssetCatalog(options)

Parameters

Parameters Type Definition

options

AssetCatalog

{
	Name        string `json:"name,omitempty"` //required
	Url         string `json:"url,omitempty"`  //required
	Description string `json:"description,omitempty"`
	AssetSample string `json:"assetSample,omitempty"` //required
	BackupIp    string `json:"backupIp,omitempty"`
}

Response

The response will be of the type AssetCatalogOutput

Type AssetCatalogOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	AssetSample string `json:"assetSample"`
	Id          uint   `json:"id"`
}

GetAssetCatalog

Method Call

response, err = broadpeak.GetAssetCatalog(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the asset catalog source assigned by broadpeak.io

Response

The response will be of the type AssetCatalogOutput

Type AssetCatalogOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	AssetSample string `json:"assetSample"`
	Id          uint   `json:"id"`
}

UpdateAssetCatalog

Method Call

response, err = broadpeak.UpdateAssetCatalog(Id, updateOptions)

Parameters

Parameters	Type	Definition
id	uint	Id of the asset catalog source assigned by broadpeak.io
updateOptions	AssetCatalog	{ Name string `json:"name,omitempty"` //required Url string `json:"url,omitempty"` //required Description string `json:"description,omitempty"` BackupIp string `json:"backupIp,omitempty"` }

Response

The response will be of the type AssetCatalogOutput

Type AssetCatalogOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	AssetSample string `json:"assetSample"`
	Id          uint   `json:"id"`
}

DeleteAssetCatalog

Method Call

response, err = broadpeak.DeleteAssetCatalog(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the asset catalog source assigned by broadpeak.io

Response

The response will be of the type AssetCatalogOutput

Type AssetCatalogOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	BackupIp    string `json:"backupIp"`
	AssetSample string `json:"assetSample"`
	Id          uint   `json:"id"`
}

Sources/Slate

CreateSlate

Method Call

response, err := broadpeak.CreateSlate(options)

Parameters

Parameters	Type	Definition
options	Slate	{ Name string `json:"name"` //required Url string `json:"url"` //required Description string `json:"description"` }

Response

The response will be of the type SlateOutput

Type SlateOutput is defined as:

{
	Id          uint   `json:"id"`
	Name        string `json:"name"`
	Url         string `json:"url"`
	Description string `json:"description"`
	Format      string `json:"format"`
}

GetSlate

Method Call

response, err = broadpeak.GetSlate(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the slate source assigned by broadpeak.io

Response

The response will be of the type SlateOutput

Type SlateOutput is defined as:

{
	Id          uint   `json:"id"`
	Name        string `json:"name"`
	Url         string `json:"url"`
	Description string `json:"description"`
	Format      string `json:"format"`
}

UpdateSlate

Method Call

response, err = broadpeak.UpdateSlate(Id, updateOptions)

Parameters

Parameters	Type	Definition
id	uint	Id of the slate source assigned by broadpeak.io
updateOptions	Slate	{ Name string `json:"name"` //required Url string `json:"url"` //required Description string `json:"description"` }

Response

The response will be of the type SlateOutput

Type SlateOutput is defined as:

{
	Id          uint   `json:"id"`
	Name        string `json:"name"`
	Url         string `json:"url"`
	Description string `json:"description"`
	Format      string `json:"format"`
}

DeleteSlate

Method Call

response, err = broadpeak.DeleteSlate(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the slate source assigned by broadpeak.io

Response

The response will be of the type SlateOutput

Type SlateOutput is defined as:

{
	Id          uint   `json:"id"`
	Name        string `json:"name"`
	Url         string `json:"url"`
	Description string `json:"description"`
	Format      string `json:"format"`
}

Sources/AdServer

CreateAdServer

Method Call

response, err := broadpeak.CreateAdServer(options)

Parameters

Parameters Type Definition

options

AdServer

{
	Name        string `json:"name,omitempty"` //required
	Url         string `json:"url,omitempty"`  //required
	Description string `json:"description,omitempty"`
	Queries     string `json:"queries,omitempty"`
	Template    string `json:"template,omitempty"` //required
}

Response

The response will be of the type AdServerOutput

Type AdServerOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	Queries     string `json:"queries"`
	Template    string `json:"template"`
	Id          uint   `json:"id"`
}

GetAdServer

Method Call

response, err = broadpeak.GetAdServer(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the ad server source assigned by broadpeak.io

Response

The response will be of the type AdServerOutput

Type AdServerOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	Queries     string `json:"queries"`
	Template    string `json:"template"`
	Id          uint   `json:"id"`
}

UpdateAdServer

Method Call

response, err = broadpeak.UpdateAdServer(Id, updateOptions)

Parameters

Parameters Type Definition

id uint Id of the ad server source assigned by broadpeak.io

updateOptions

AdServer

{
	Name        string `json:"name,omitempty"` //required
	Url         string `json:"url,omitempty"`  //required
	Description string `json:"description,omitempty"`
	Queries     string `json:"queries,omitempty"`
	Template    string `json:"template,omitempty"` //required
}

Response

The response will be of the type AdServerOutput

Type AdServerOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	Queries     string `json:"queries"`
	Template    string `json:"template"`
	Id          uint   `json:"id"`
}

DeleteAdServer

Method Call

response, err = broadpeak.DeleteAdServer(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the ad server source assigned by broadpeak.io

Response

The response will be of the type AdServerOutput

Type AdServerOutput is defined as:

{
	Name        string `json:"name"`
	Description string `json:"description"`
	Url         string `json:"url"`
	Queries     string `json:"queries"`
	Template    string `json:"template"`
	Id          uint   `json:"id"`
}

Services

GetAllServices

Method Call

response, err := broadpeak.GetAllServices(offset, limit)

Parameters

Parameters	Type	Definition
Offset	uint	Offset of the first result to return.
Limit	uint	Maximum number of results to return

Response

The response will be of the type []ServiceOutput

Type ServiceOutput is defined as:

{
    Name            string   `json:"name"`
    EnvironmentTags []string `json:"environmentTags"`
    Id              uint     `json:"id"`
    Type            []string `json:"type"`
    Url             string   `json:"url"`
    UpdateDate      string   `json:"updateDate"`
    CreationDate    string   `json:"creationDate"`
}

Sources/ContentReplacement

CreateContentReplacement

Method Call

response, err := broadpeak.CreateContentReplacement(options)

Parameters

Parameters Type Definition

options

CreateContentReplacement

{
	Name        string   `json:"name,omitempty"`        //required
	Replacement Identifiable `json:"replacement,omitempty"` //required
	Source      Identifiable `json:"source,omitempty"`      //required
	EnvTags     []string `json:"environmentTags,omitempty"`
}

Response

The response will be of the type ContentReplacementOutput

Type ContentReplacementOutput is defined as:

{
	Name            string        `json:"name"`
	EnvironmentTags []string      `json:"environmentTags"`
	Replacement     IdNameUrlType `json:"replacement"`
	Source          IdNameUrlType `json:"source"`
	Id              uint          `json:"id"`
	Url             string        `json:"url"`
	UpdateDate      string        `json:"updateDate"`
	CreationDate    string        `json:"creationDate"`
}

GetContentReplacement

Method Call

response, err = broadpeak.GetContentReplacement(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the service

Response

The response will be of the type ContentReplacementOutput

Type ContentReplacementOutput is defined as:

{
	Name            string        `json:"name"`
	EnvironmentTags []string      `json:"environmentTags"`
	Replacement     IdNameUrlType `json:"replacement"`
	Source          IdNameUrlType `json:"source"`
	Id              uint          `json:"id"`
	Url             string        `json:"url"`
	UpdateDate      string        `json:"updateDate"`
	CreationDate    string        `json:"creationDate"`
}

UpdateContentReplacement

Method Call

response, err = broadpeak.UpdateContentReplacement(Id, updateOptions)

Parameters

Parameters	Type	Definition
id	uint	Id of the service
updateOptions	UpdateContentReplacement	{ Name string `json:"name,omitempty"` //required Replacement Identifiable `json:"replacement,omitempty"` //required EnvTags []string `json:"environmentTags,omitempty"` }

Response

The response will be of the type ContentReplacementOutput

Type ContentReplacementOutput is defined as:

{
	Name            string        `json:"name"`
	EnvironmentTags []string      `json:"environmentTags"`
	Replacement     IdNameUrlType `json:"replacement"`
	Source          IdNameUrlType `json:"source"`
	Id              uint          `json:"id"`
	Url             string        `json:"url"`
	UpdateDate      string        `json:"updateDate"`
	CreationDate    string        `json:"creationDate"`
}

DeleteContentReplacement

Method Call

response, err = broadpeak.DeleteContentReplacement(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the service

Response

The response will be of the type ContentReplacementOutput

Type ContentReplacementOutput is defined as:

{
	Name            string        `json:"name"`
	EnvironmentTags []string      `json:"environmentTags"`
	Replacement     IdNameUrlType `json:"replacement"`
	Source          IdNameUrlType `json:"source"`
	Id              uint          `json:"id"`
	Url             string        `json:"url"`
	UpdateDate      string        `json:"updateDate"`
	CreationDate    string        `json:"creationDate"`
}

Sources/ContentReplacementSlot

CreateContentReplacementSlot

Method Call

response, err := broadpeak.CreateContentReplacementSlot(serviceId, options)

Parameters

Parameters Type Definition

serviceId uint Id of the service

options

CreateContentReplacementSlot

{
	Name        string   `json:"name,omitempty"`
	StartTime   string   `json:"startTime,omitempty"` //required
	EndTime     string   `json:"endTime,omitempty"`
	Duration    uint     `json:"duration,omitempty"`
	Replacement Identifiable `json:"replacement,omitempty"`
}

Response

The response will be of the type ContentReplacementSlotOutput

Type ContentReplacementSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    CategoryOutput     `json:"category"`
	Id          uint          `json:"id"`
}

GetContentReplacementSlot

Method Call

response, err = broadpeak.GetContentReplacementSlot(serviceId, Id)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
id	uint	Id of the content replacement slot

Response

The response will be of the type ContentReplacementSlotOutput

Type ContentReplacementSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    CategoryOutput     `json:"category"`
	Id          uint          `json:"id"`
}

GetAllContentReplacementSlots

Method Call

response, err = broadpeak.GetAllContentReplacementSlots(serviceId, getAllSlotsOptions)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
getAllSlotsOptions	GetAllSlots	`{ Offset uint Limit uint Categories []uint From uint To uint }`

Response

The response will be of the type []ContentReplacementSlotOutput

Type ContentReplacementSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    CategoryOutput     `json:"category"`
	Id          uint          `json:"id"`
}

UpdateContentReplacementSlot

Method Call

response, err = broadpeak.UpdateContentReplacementSlot(serviceId, Id, updateOptions)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
id	uint	Id of the content replacement slot
updateOptions	UpdateContentReplacementSlot	{ Name string `json:"name,omitempty"` StartTime string `json:"startTime,omitempty"` //required EndTime string `json:"endTime,omitempty"` Duration uint `json:"duration,omitempty"` Replacement Identifiable `json:"replacement,omitempty"` Category Identifiable `json:"category,omitempty"` }

Response

The response will be of the type ContentReplacementSlotOutput

Type ContentReplacementSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    CategoryOutput     `json:"category"`
	Id          uint          `json:"id"`
}

DeleteContentReplacementSlot

Method Call

response, err = broadpeak.DeleteContentReplacementSlot(serviceId, Id)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
id	uint	Id of the content replacement slot

Response

The response will be of the type ContentReplacementSlotOutput

Type ContentReplacementSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    CategoryOutput     `json:"category"`
	Id          uint          `json:"id"`
}

Sources/VirtualChannel

CreateVirtualChannel

Method Call

response, err := broadpeak.CreateVirtualChannel(options)

Parameters

Parameters Type Definition

options

CreateVirtualChannel

{
	Name                 string               `json:"name,omitempty"` //required
	EnvTags              []string             `json:"environmentTags,omitempty"`
	AdBreakInsertion     AdBreakInsertion     `json:"adBreakInsertion,omitempty"`
	TranscodingProfile   Identifiable             `json:"transcodingProfile,omitempty"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking,omitempty"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding,omitempty"`
	BaseLive             Identifiable             `json:"baseLive,omitempty"` //required
}

Response

The response will be of the type VirtualChannelOutput

Type VirtualChannelOutput is defined as:

{
	Name                 string               `json:"name"`
	EnvironmentTags      []string             `json:"environmentTags"`
	AdBreakInsertion     AdBreakInsertionOutput    `json:"adBreakInsertion"`
	TranscodingProfiles  TranscodingProfileOutput `json:"transcodingProfile"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	BaseLive             IdNameUrlType        `json:"baseLive"`
	Id                   uint                 `json:"id"`
	Url                  string               `json:"url"`
	UpdateDate           string               `json:"updateDate"`
	CreationDate         string               `json:"creationDate"`
}

GetVirtualChannel

Method Call

response, err = broadpeak.GetVirtualChannel(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the virtual channel

Response

The response will be of the type VirtualChannelOutput

Type VirtualChannelOutput is defined as:

{
	Name                 string               `json:"name"`
	EnvironmentTags      []string             `json:"environmentTags"`
	AdBreakInsertion     AdBreakInsertionOutput    `json:"adBreakInsertion"`
	TranscodingProfiles  TranscodingProfileOutput `json:"transcodingProfile"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	BaseLive             IdNameUrlType        `json:"baseLive"`
	Id                   uint                 `json:"id"`
	Url                  string               `json:"url"`
	UpdateDate           string               `json:"updateDate"`
	CreationDate         string               `json:"creationDate"`
}

UpdateVirtualChannel

Method Call

response, err = broadpeak.UpdateVirtualChannel(Id, updateOptions)

Parameters

Parameters Type Definition

id uint Id of the virtual channel

updateOptions

UpdateVirtualChannel

{
	Name                 string               `json:"name,omitempty"` //required
	EnvTags              []string             `json:"environmentTags,omitempty"`
	AdBreakInsertion     AdBreakInsertion     `json:"adBreakInsertion,omitempty"`
	TranscodingProfile   Identifiable             `json:"transcodingProfile,omitempty"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking,omitempty"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding,omitempty"`
}

Response

The response will be of the type VirtualChannelOutput

Type VirtualChannelOutput is defined as:

{
	Name                 string               `json:"name"`
	EnvironmentTags      []string             `json:"environmentTags"`
	AdBreakInsertion     AdBreakInsertionOutput    `json:"adBreakInsertion"`
	TranscodingProfiles  TranscodingProfileOutput `json:"transcodingProfile"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	BaseLive             IdNameUrlType        `json:"baseLive"`
	Id                   uint                 `json:"id"`
	Url                  string               `json:"url"`
	UpdateDate           string               `json:"updateDate"`
	CreationDate         string               `json:"creationDate"`
}

DeleteVirtualChannel

Method Call

response, err = broadpeak.DeleteVirtualChannel(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the virtual channel

Response

The response will be of the type VirtualChannelOutput

Type VirtualChannelOutput is defined as:

{
	Name                 string               `json:"name"`
	EnvironmentTags      []string             `json:"environmentTags"`
	AdBreakInsertion     AdBreakInsertionOutput    `json:"adBreakInsertion"`
	TranscodingProfiles  TranscodingProfileOutput `json:"transcodingProfile"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	BaseLive             IdNameUrlType        `json:"baseLive"`
	Id                   uint                 `json:"id"`
	Url                  string               `json:"url"`
	UpdateDate           string               `json:"updateDate"`
	CreationDate         string               `json:"creationDate"`
}

Sources/VirtualChannelSlot

CreateVirtualChannelSlot

Method Call

response, err := broadpeak.CreateVirtualChannelSlot(serviceId, options)

Parameters

Parameters Type Definition

serviceId uint Id of the service

options

CreateVirtualChannelSlot

{
	Name        string   `json:"name,omitempty"`
	StartTime   string   `json:"startTime,omitempty"` //required
	EndTime     string   `json:"endTime,omitempty"`
	Duration    uint     `json:"duration,omitempty"`
	Replacement Identifiable `json:"replacement,omitempty"`
	Category    Identifiable `json:"category,omitempty"`
	Type        string   `json:"type,omitempty"`
}

Response

The response will be of the type VirtualChannelSlotOutput

Type VirtualChannelSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    Identifiable      `json:"category"`
	Type        string        `json:"type"`
}

GetVirtualChannelSlot

Method Call

response, err = broadpeak.GetVirtualChannelSlot(serviceId, Id)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
id	uint	Id of the virtual channel slot

Response

The response will be of the type VirtualChannelSlotOutput

Type VirtualChannelSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    Identifiable      `json:"category"`
	Type        string        `json:"type"`
}

GetAllVirtualChannelSlots

Method Call

response, err = broadpeak.GetAllVirtualChannelSlots(serviceId, getAllSlotsOptions)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
getAllSlotsOptions	GetAllSlots	`{ Offset uint Limit uint Categories []uint From uint To uint }`

Response

The response will be of the type []VirtualChannelSlotOutput

Type VirtualChannelSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    Identifiable      `json:"category"`
	Type        string        `json:"type"`
}

UpdateVirtualChannelSlot

Method Call

response, err = broadpeak.UpdateVirtualChannelSlot(serviceId, Id, updateOptions)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
id	uint	Id of the virtual channel slot
updateOptions	UpdateVirtualChannelSlot	{ Name string `json:"name,omitempty"` StartTime string `json:"startTime,omitempty"` //required EndTime string `json:"endTime,omitempty"` Duration uint `json:"duration,omitempty"` Replacement Identifiable `json:"replacement,omitempty"` Category Identifiable `json:"category,omitempty"` Type string `json:"type,omitempty"` }

Response

The response will be of the type VirtualChannelSlotOutput

Type VirtualChannelSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    Identifiable      `json:"category"`
	Type        string        `json:"type"`
}

DeleteVirtualChannelSlot

Method Call

response, err = broadpeak.DeleteVirtualChannelSlot(serviceId, Id)

Parameters

Parameters	Type	Definition
serviceId	uint	Id of the service
id	uint	Id of the virtual channel slot

Response

The response will be of the type VirtualChannelSlotOutput

Type VirtualChannelSlotOutput is defined as:

{
	Name        string        `json:"name"`
	StartTime   string        `json:"startTime"`
	EndTime     string        `json:"endTime"`
	Duration    uint          `json:"duration"`
	Replacement IdNameUrlType `json:"replacement"`
	Category    Identifiable      `json:"category"`
	Type        string        `json:"type"`
}

Sources/AdInsertion

CreateAdInsertion

Method Call

response, err := broadpeak.CreateAdInsertion(options)

Parameters

Parameters Type Definition

options

CreateAdInsertion

{
	Name                 string               `json:"name,omitempty"` //required
	EnvTags              []string             `json:"environmentTags,omitempty"`
	LiveAdPreRoll        LiveAdPreRoll        `json:"liveAdPreRoll,omitempty"`
	LiveAdReplacement    LiveAdReplacement    `json:"liveAdReplacement,omitempty"`
	VodAdInsertion       VodAdInsertion       `json:"vodAdInsertion,omitempty"`
	TranscodingProfile   Identifiable             `json:"transcodingProfile,omitempty"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding,omitempty"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking,omitempty"`
	Source               Identifiable             `json:"source,omitempty"` //required
}

Response

The response will be of the type AdInsertionOutput

Type AdInsertionOutput is defined as:

{
	Name                 string               `json:"name,omitempty"`
	EnvironmentTags      []string             `json:"environmentTags,omitempty"`
	LiveAdPreRoll        LiveAdPreRollOutput       `json:"liveAdPreRoll"`
	LiveAdReplacement    LiveAdReplacementOutput   `json:"liveAdReplacement"`
	VodAdInsertion       VodAdInsertionOutput      `json:"vodAdInsertion"`
	TranscodingProfile   NameContentId        `json:"transcodingProfile"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	Source               IdNameUrlQueries     `json:"source"`
	Id                   uint                 `json:"id"`
	CreationDate         string               `json:"creationDate"`
	UpdateDate           string               `json:"updateDate"`
	Url                  string               `json:"url"`
}

GetAdInsertion

Method Call

response, err = broadpeak.GetAdInsertion(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the ad-insertion service

Response

The response will be of the type AdInsertionOutput

Type AdInsertionOutput is defined as:

{
	Name                 string               `json:"name,omitempty"`
	EnvironmentTags      []string             `json:"environmentTags,omitempty"`
	LiveAdPreRoll        LiveAdPreRollOutput       `json:"liveAdPreRoll"`
	LiveAdReplacement    LiveAdReplacementOutput   `json:"liveAdReplacement"`
	VodAdInsertion       VodAdInsertionOutput      `json:"vodAdInsertion"`
	TranscodingProfile   NameContentId        `json:"transcodingProfile"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	Source               IdNameUrlQueries     `json:"source"`
	Id                   uint                 `json:"id"`
	CreationDate         string               `json:"creationDate"`
	UpdateDate           string               `json:"updateDate"`
	Url                  string               `json:"url"`
}

UpdateAdInsertion

Method Call

response, err = broadpeak.UpdateAdInsertion(Id, updateOptions)

Parameters

Parameters Type Definition

id uint Id of the ad-insertion service

updateOptions

updateAdInsertion

{
	Name                 string               `json:"name,omitempty"` //required
	EnvTags              []string             `json:"environmentTags,omitempty"`
	LiveAdPreRoll        LiveAdPreRoll        `json:"liveAdPreRoll,omitempty"`
	LiveAdReplacement    LiveAdReplacement    `json:"liveAdReplacement,omitempty"`
	VodAdInsertion       VodAdInsertion       `json:"vodAdInsertion,omitempty"`
	TranscodingProfile   Identifiable             `json:"transcodingProfile,omitempty"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding,omitempty"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking,omitempty"`
}

Response

The response will be of the type AdInsertionOutput

Type AdInsertionOutput is defined as:

{
	Name                 string               `json:"name,omitempty"`
	EnvironmentTags      []string             `json:"environmentTags,omitempty"`
	LiveAdPreRoll        LiveAdPreRollOutput       `json:"liveAdPreRoll"`
	LiveAdReplacement    LiveAdReplacementOutput   `json:"liveAdReplacement"`
	VodAdInsertion       VodAdInsertionOutput      `json:"vodAdInsertion"`
	TranscodingProfile   NameContentId        `json:"transcodingProfile"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	Source               IdNameUrlQueries     `json:"source"`
	Id                   uint                 `json:"id"`
	CreationDate         string               `json:"creationDate"`
	UpdateDate           string               `json:"updateDate"`
	Url                  string               `json:"url"`
}

DeleteAdInsertion

Method Call

response, err = broadpeak.DeleteAdInsertion(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the ad-insertion service

Response

The response will be of the type AdInsertionOutput

Type AdInsertionOutput is defined as:

{
	Name                 string               `json:"name,omitempty"`
	EnvironmentTags      []string             `json:"environmentTags,omitempty"`
	LiveAdPreRoll        LiveAdPreRollOutput       `json:"liveAdPreRoll"`
	LiveAdReplacement    LiveAdReplacementOutput   `json:"liveAdReplacement"`
	VodAdInsertion       VodAdInsertionOutput      `json:"vodAdInsertion"`
	TranscodingProfile   NameContentId        `json:"transcodingProfile"`
	EnableAdTranscoding  bool                 `json:"enableAdTranscoding"`
	ServerSideAdTracking ServerSideAdTracking `json:"serverSideAdTracking"`
	Source               IdNameUrlQueries     `json:"source"`
	Id                   uint                 `json:"id"`
	CreationDate         string               `json:"creationDate"`
	UpdateDate           string               `json:"updateDate"`
	Url                  string               `json:"url"`
}

TranscodingProfiles

GetAllTranscodingProfiles

Method Call

response, err := broadpeak.GetAllTranscodingProfiles(offset, limit)

Parameters

Parameters	Type	Definition
Offset	uint	Offset of the first result to return.
Limit	uint	Maximum number of results to return

Response

The response will be of the type []TranscodingProfileOutput

Type TranscodingProfileOutput is defined as:

{
	Name    string `json:"name"`
	Content string `json:"content"`
	Id      uint   `json:"id"`
}

GetTranscodingProfile

Method Call

response, err = broadpeak.GetTranscodingProfile(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the transcoding profile

Response

The response will be of the type TranscodingProfileOutput

Type TranscodingProfileOutput is defined as:

	{
	Name    string `json:"name"`
	Content string `json:"content"`
	Id      uint   `json:"id"`
}

ESNI

CreateUpdateMediaPoint

Method Call

response, err := broadpeak.CreateUpdateMediaPoint(id)

Parameters

Parameters	Type	Definition
id	string	Media point id

Response

The response will be of the type string

GetMediaPoint

Method Call

response, err = broadpeak.GetMediaPoint(Id)

Parameters

Parameters	Type	Definition
id	string	id of an existing MediaPoint

Users

GetUser

Method Call

response, err = broadpeak.GetUser(Id)

Parameters

Parameters	Type	Definition
id	uint	Id of the user

Response

The response will be of the type UserOutput

Type UserOutput is defined as:

{
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
	Email     string `json:"email"`
	TenantId  string `json:"tenantId"`
}

GetAllUsers

Method Call

response, err := broadpeak.GetAllUsers(offset, limit, withEmailStatus)

Parameters

Parameters	Type	Definition
Offset	uint	Offset of the first result to return.
Limit	uint	Maximum number of results to return
withEmailStatus	bool	Get email status flag

Response

The response will be of the type []UserOutput

Type UserOutput is defined as:

{
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
	Email     string `json:"email"`
	TenantId  string `json:"tenantId"`
}

UpdateUser

Method Call

response, err = broadpeak.UpdateUser(Id, updateOptions)

Parameters

Parameters	Type	Definition
id	uint	User id
updateOptions	User	{ FirstName string `json:"firstName,omitempty"` LastName string `json:"lastName,omitempty"` Email string `json:"email,omitempty"` }

Response

The response will be of the type UserOutput

Type UserOutput is defined as:

{
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
	Email     string `json:"email"`
	TenantId  string `json:"tenantId"`
}

DeleteUser

Method Call

response, err = broadpeak.DeleteUser(Id)

Parameters

Parameters	Type	Definition
id	uint	User id

Response

The response will be of the type string

ApplicationStatus

CheckApplicationStatus

Method Call

response, err = broadpeak.ApplicationStatus()

Parameters

The method call requires no parameters

Response

The response will be of the type string

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
.github/workflows		.github/workflows
.editorconfig		.editorconfig
.gitignore		.gitignore
README.md		README.md
api_misc_apiKey.go		api_misc_apiKey.go
api_misc_applicationStatus.go		api_misc_applicationStatus.go
api_misc_categories.go		api_misc_categories.go
api_misc_consumptions.go		api_misc_consumptions.go
api_misc_transcodingProfiles.go		api_misc_transcodingProfiles.go
api_misc_users.go		api_misc_users.go
api_services.go		api_services.go
api_services_adInsertion.go		api_services_adInsertion.go
api_services_common.go		api_services_common.go
api_services_contentReplacement.go		api_services_contentReplacement.go
api_services_slots_contentReplacementSlots.go		api_services_slots_contentReplacementSlots.go
api_services_slots_virtualChannelSlot.go		api_services_slots_virtualChannelSlot.go
api_services_virtualChannel.go		api_services_virtualChannel.go
api_sources.go		api_sources.go
api_sources_adServers.go		api_sources_adServers.go
api_sources_assetCatalogs.go		api_sources_assetCatalogs.go
api_sources_assets.go		api_sources_assets.go
api_sources_lives.go		api_sources_lives.go
api_sources_samples.go		api_sources_samples.go
api_sources_slates.go		api_sources_slates.go
api_utils.go		api_utils.go
api_utils_http.go		api_utils_http.go
broadpeak_test.go		broadpeak_test.go
broadpeakio.go		broadpeakio.go
go.mod		go.mod

broadpeak-io/go-sdk

Folders and files

Latest commit

History

Repository files navigation

Broadpeak.io SDK

Package

Initializing the Broadpeak object

How to use the SDK

Sources

GetAllSources

Method Call

Parameters

Response

GetSource

Method Call

Parameters

Response

Sources/Live

CreateLiveSource

Method Call

Parameters

Response

GetLiveSource

Method Call

Parameters

Response

UpdateLiveSource

Method Call

Parameters

Response

DeleteLiveSource

Method Call

Parameters

Response

Sources/Asset

CreateAsset

Method Call

Parameters

Response

GetAsset

Method Call

Parameters

Response

UpdateAsset

Method Call

Parameters

Response

DeleteAsset

Method Call

Parameters

Response

Sources/AssetCatalog

CreateAssetCatalog

Method Call

Parameters

Response

GetAssetCatalog

Method Call

Parameters

Response

UpdateAssetCatalog

Method Call

Parameters

Response

DeleteAssetCatalog

Method Call

Parameters

Response

Sources/Slate

CreateSlate

Method Call

Parameters

Response

GetSlate

Method Call

Parameters

Response

UpdateSlate

Method Call