ubox

Documentation

Overview

Package ubox include resources of ucloud ubox product

See also

• API: https://docs.ucloud.cn/api/ubox-api/index
• Product: https://www.ucloud.cn/site/product/ubox.html

for detail.

Index

• type CameraStream
• type GetSdnboxCameraListRequest
• type GetSdnboxCameraListResponse
• type PullRTMPAddress
• type SdnboxCamera
• type StartSdnboxCameraPushingRequest
• type StartSdnboxCameraPushingResponse
• type StopSdnboxCameraPushingRequest
• type StopSdnboxCameraPushingResponse
• type UBoxClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *UBoxClient
  • func (c *UBoxClient) GetSdnboxCameraList(req *GetSdnboxCameraListRequest) (*GetSdnboxCameraListResponse, error)
  • func (c *UBoxClient) NewGetSdnboxCameraListRequest() *GetSdnboxCameraListRequest
  • func (c *UBoxClient) NewStartSdnboxCameraPushingRequest() *StartSdnboxCameraPushingRequest
  • func (c *UBoxClient) NewStopSdnboxCameraPushingRequest() *StopSdnboxCameraPushingRequest
  • func (c *UBoxClient) StartSdnboxCameraPushing(req *StartSdnboxCameraPushingRequest) (*StartSdnboxCameraPushingResponse, error)
  • func (c *UBoxClient) StopSdnboxCameraPushing(req *StopSdnboxCameraPushingRequest) (*StopSdnboxCameraPushingResponse, error)

Types

type CameraStream

type CameraStream struct {

	// 摄像头ID
	ID string

	// 摄像头是否在线
	IsOnline bool

	// 摄像头名称
	Name string

	// 拉流地址, 是 map 格式, key 是流类型, value是地址
	PullRTMPAddress PullRTMPAddress

	// 小窗口视频拉流地址
	SmallPullRTMPAddress string

	// 推流状态
	Status int

	// 视频参数
	VideoParams string
}

CameraStream - 摄像头推/拉流信息

type GetSdnboxCameraListRequest

type GetSdnboxCameraListRequest struct {
	request.CommonBase
}

GetSdnboxCameraListRequest is request schema for GetSdnboxCameraList action

type GetSdnboxCameraListResponse

type GetSdnboxCameraListResponse struct {
	response.CommonBase

	// 摄像头推流列表
	SdnboxCamera []SdnboxCamera
}

GetSdnboxCameraListResponse is response schema for GetSdnboxCameraList action

type PullRTMPAddress

type PullRTMPAddress struct {

	//
	Dash string

	//
	Flv string

	//
	Hls string

	//
	Rtmp string

	//
	Webrtc string
}

PullRTMPAddress -

type SdnboxCamera

type SdnboxCamera struct {

	// 摄像头流信息列表
	Camera []CameraStream

	// 盒子ID
	ID string

	// 盒子名称
	Name string
}

SdnboxCamera - 盒子连接的摄像头信息

type StartSdnboxCameraPushingRequest

type StartSdnboxCameraPushingRequest struct {
	request.CommonBase

	// 摄像头ID
	CameraId *string `required:"true"`

	// 盒子ID
	SdnboxId *string `required:"true"`
}

StartSdnboxCameraPushingRequest is request schema for StartSdnboxCameraPushing action

type StartSdnboxCameraPushingResponse

type StartSdnboxCameraPushingResponse struct {
	response.CommonBase
}

StartSdnboxCameraPushingResponse is response schema for StartSdnboxCameraPushing action

type StopSdnboxCameraPushingRequest

type StopSdnboxCameraPushingRequest struct {
	request.CommonBase

	// 摄像头ID
	CameraId *string `required:"true"`

	// 盒子ID
	SdnboxId *string `required:"true"`
}

StopSdnboxCameraPushingRequest is request schema for StopSdnboxCameraPushing action

type StopSdnboxCameraPushingResponse

type StopSdnboxCameraPushingResponse struct {
	response.CommonBase
}

StopSdnboxCameraPushingResponse is response schema for StopSdnboxCameraPushing action

type UBoxClient

type UBoxClient struct {
	*ucloud.Client
}

UBoxClient is the client of UBox

func NewClient

func NewClient(config *ucloud.Config, credential *auth.Credential) *UBoxClient

NewClient will return a instance of UBoxClient

func (*UBoxClient) GetSdnboxCameraList

func (c *UBoxClient) GetSdnboxCameraList(req *GetSdnboxCameraListRequest) (*GetSdnboxCameraListResponse, error)

API: GetSdnboxCameraList

获取盒子摄像头推流列表

func (*UBoxClient) NewGetSdnboxCameraListRequest

func (c *UBoxClient) NewGetSdnboxCameraListRequest() *GetSdnboxCameraListRequest

NewGetSdnboxCameraListRequest will create request of GetSdnboxCameraList action.

func (*UBoxClient) NewStartSdnboxCameraPushingRequest

func (c *UBoxClient) NewStartSdnboxCameraPushingRequest() *StartSdnboxCameraPushingRequest

NewStartSdnboxCameraPushingRequest will create request of StartSdnboxCameraPushing action.

func (*UBoxClient) NewStopSdnboxCameraPushingRequest

func (c *UBoxClient) NewStopSdnboxCameraPushingRequest() *StopSdnboxCameraPushingRequest

NewStopSdnboxCameraPushingRequest will create request of StopSdnboxCameraPushing action.

func (*UBoxClient) StartSdnboxCameraPushing

func (c *UBoxClient) StartSdnboxCameraPushing(req *StartSdnboxCameraPushingRequest) (*StartSdnboxCameraPushingResponse, error)

API: StartSdnboxCameraPushing

摄像头推流开启

func (*UBoxClient) StopSdnboxCameraPushing

func (c *UBoxClient) StopSdnboxCameraPushing(req *StopSdnboxCameraPushingRequest) (*StopSdnboxCameraPushingResponse, error)

API: StopSdnboxCameraPushing

摄像头推流关闭