api

Documentation

Overview

Package api defines all APIs supported by the VCA service of BCE.

Index

• Constants
• type AnalyzeAttribute
• type AnalyzeError
• type AnalyzeResult
• type GetMediaResult
  • func GetMedia(cli bce.Client, source string) (*GetMediaResult, error)
  • func PutMedia(cli bce.Client, args *PutMediaArgs) (*GetMediaResult, error)
• type PutMediaArgs
• type TimePeriod

Constants

const (
	URI_PREFIX = bce.URI_PREFIX + "v1"
	MEDIA_URI  = "/media"
)

Types

type AnalyzeAttribute

type AnalyzeAttribute struct {
	Attribute     string       `json:"attribute"`
	Confidence    float32      `json:"confidence"`
	Source        string       `json:"source"`
	AttributeTime []TimePeriod `json:"time"`
}

type AnalyzeError

type AnalyzeError struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type AnalyzeResult

type AnalyzeResult struct {
	Type       string             `json:"type"`
	Attributes []AnalyzeAttribute `json:"result"`
}

type GetMediaResult

type GetMediaResult struct {
	Source       string          `json:"source"`
	MediaId      string          `json:"mediaId"`
	Title        string          `json:"title"`
	Description  string          `json:"description"`
	Preset       string          `json:"preset"`
	Status       string          `json:"status"`
	Percent      int             `json:"percent"`
	Notification string          `json:"notification"`
	CreateTime   string          `json:"createTime"`
	StartTime    string          `json:"startTime"`
	PublishTime  string          `json:"publishTime"`
	Results      []AnalyzeResult `json:"results"`
	Error        AnalyzeError    `json:"error"`
}

func GetMedia

func GetMedia(cli bce.Client, source string) (*GetMediaResult, error)

func PutMedia

func PutMedia(cli bce.Client, args *PutMediaArgs) (*GetMediaResult, error)

type PutMediaArgs

type PutMediaArgs struct {
	Source       string `json:"source"`
	Auth         string `json:"auth"`
	Title        string `json:"title"`
	Description  string `json:"description"`
	Preset       string `json:"preset"`
	Notification string `json:"notification"`
}

type TimePeriod

type TimePeriod struct {
	Start int `json:"start"`
	End   int `json:"end"`
}