model

package
v0.1.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 30, 2022 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App added in v0.0.53

type App struct {

	// app名称
	AppName *string `json:"app_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	State *AppState `json:"state,omitempty"`

	// RTC覆盖范围。  取值如下:    - DOMESTIC:国内范围。   - OVERSEA:海外范围。   - GLOBAL:全球范围。
	Scope *AppScope `json:"scope,omitempty"`

	// 账号名
	TenantName *string `json:"tenant_name,omitempty"`

	// 域名,App对应域名
	Domain *string `json:"domain,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	Authentication *AppAuth `json:"authentication,omitempty"`

	Callbacks *AppCallbacks `json:"callbacks,omitempty"`

	AutoRecordMode *AppAutoRecordMode `json:"auto_record_mode,omitempty"`
}

app详细信息

func (App) String added in v0.0.53

func (o App) String() string

type AppAuth added in v0.0.53

type AppAuth struct {

	// 开启或关闭URL鉴权
	Enable *bool `json:"enable,omitempty"`

	// 接入RTC建链认证时的signature的有效期。单位:秒。默认300秒。signature由app_key生成
	Expire *int32 `json:"expire,omitempty"`

	// app鉴权秘钥
	AppKey *string `json:"app_key,omitempty"`

	// app鉴权的更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`
}

鉴权配置

func (AppAuth) String added in v0.0.53

func (o AppAuth) String() string

type AppAuthReq added in v0.0.53

type AppAuthReq struct {

	// 开启或关闭URL鉴权
	Enable bool `json:"enable"`

	// 有效期,当开启鉴权时必填。  取值范围:[60,2592000],缺省为300。  单位:秒。
	Expire *int32 `json:"expire,omitempty"`
}

修改app鉴权请求

func (AppAuthReq) String added in v0.0.53

func (o AppAuthReq) String() string

type AppAutoRecordMode added in v0.0.53

type AppAutoRecordMode struct {

	// 录制模式。 - AUTO_RECORD_OFF:关闭自动录制。 - AUTO_INDIVIDUAL_RECORD:开启单流自动录制,此时record_rule_id必须非空。
	Mode AppAutoRecordModeMode `json:"mode"`

	// 录制规则id。
	RecordRuleId *string `json:"record_rule_id,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC。
	UpdateTime *string `json:"update_time,omitempty"`
}

app自动录制模式

func (AppAutoRecordMode) String added in v0.0.53

func (o AppAutoRecordMode) String() string

type AppAutoRecordModeMode added in v0.0.53

type AppAutoRecordModeMode struct {
	// contains filtered or unexported fields
}

func (AppAutoRecordModeMode) MarshalJSON added in v0.0.53

func (c AppAutoRecordModeMode) MarshalJSON() ([]byte, error)

func (*AppAutoRecordModeMode) UnmarshalJSON added in v0.0.53

func (c *AppAutoRecordModeMode) UnmarshalJSON(b []byte) error

func (AppAutoRecordModeMode) Value added in v0.0.90

func (c AppAutoRecordModeMode) Value() string

type AppAutoRecordModeModeEnum added in v0.0.53

type AppAutoRecordModeModeEnum struct {
	AUTO_RECORD_OFF        AppAutoRecordModeMode
	AUTO_INDIVIDUAL_RECORD AppAutoRecordModeMode
}

func GetAppAutoRecordModeModeEnum added in v0.0.53

func GetAppAutoRecordModeModeEnum() AppAutoRecordModeModeEnum

type AppCallbackUrl added in v0.0.53

type AppCallbackUrl struct {

	// 回调通知url地址,url必须以http://或https://开头,需要支持POST调用。
	Url *string `json:"url,omitempty"`

	// 回调秘钥,主要用于鉴权。如果不设置或者为空,则回调不会增加鉴权头域字段。
	AuthKey *string `json:"auth_key,omitempty"`

	// 订阅云端录制通知消息。  取值如下:  - RECORD_NEW_FILE_START:录制模块开始创建新的录制文件。  - RECORD_FILE_COMPLETE:录制模块已经生成录制文件。
	NotifyEventSubscription *[]AppCallbackUrlNotifyEventSubscription `json:"notify_event_subscription,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC。
	UpdateTime *string `json:"update_time,omitempty"`
}

回调配置

func (AppCallbackUrl) String added in v0.0.53

func (o AppCallbackUrl) String() string

type AppCallbackUrlNotifyEventSubscription added in v0.0.53

type AppCallbackUrlNotifyEventSubscription struct {
	// contains filtered or unexported fields
}

func (AppCallbackUrlNotifyEventSubscription) MarshalJSON added in v0.0.53

func (c AppCallbackUrlNotifyEventSubscription) MarshalJSON() ([]byte, error)

func (*AppCallbackUrlNotifyEventSubscription) UnmarshalJSON added in v0.0.53

func (c *AppCallbackUrlNotifyEventSubscription) UnmarshalJSON(b []byte) error

func (AppCallbackUrlNotifyEventSubscription) Value added in v0.0.90

type AppCallbackUrlNotifyEventSubscriptionEnum added in v0.0.53

type AppCallbackUrlNotifyEventSubscriptionEnum struct {
	RECORD_NEW_FILE_START AppCallbackUrlNotifyEventSubscription
	RECORD_FILE_COMPLETE  AppCallbackUrlNotifyEventSubscription
}

func GetAppCallbackUrlNotifyEventSubscriptionEnum added in v0.0.53

func GetAppCallbackUrlNotifyEventSubscriptionEnum() AppCallbackUrlNotifyEventSubscriptionEnum

type AppCallbackUrlReq added in v0.0.53

type AppCallbackUrlReq struct {

	// 回调通知url地址,url必须以http://或https://开头,需要支持POST调用。
	Url string `json:"url"`

	// 回调秘钥,主要用于鉴权
	AuthKey *string `json:"auth_key,omitempty"`
}

修改app回调请求

func (AppCallbackUrlReq) String added in v0.0.53

func (o AppCallbackUrlReq) String() string

type AppCallbacks added in v0.0.53

type AppCallbacks struct {
	PushCallback *AppCallbackUrl `json:"push_callback,omitempty"`

	RecordCallback *AppCallbackUrl `json:"record_callback,omitempty"`
}

app回调配置

func (AppCallbacks) String added in v0.0.53

func (o AppCallbacks) String() string

type AppReq added in v0.0.53

type AppReq struct {

	// app名称,仅支持填入utf8格式内容
	AppName string `json:"app_name"`
}

创建应用请求体

func (AppReq) String added in v0.0.53

func (o AppReq) String() string

type AppScope added in v0.0.53

type AppScope struct {
	// contains filtered or unexported fields
}

func (AppScope) MarshalJSON added in v0.0.53

func (c AppScope) MarshalJSON() ([]byte, error)

func (*AppScope) UnmarshalJSON added in v0.0.53

func (c *AppScope) UnmarshalJSON(b []byte) error

func (AppScope) Value added in v0.0.90

func (c AppScope) Value() string

type AppScopeEnum added in v0.0.53

type AppScopeEnum struct {
	DOMESTIC AppScope
	OVERSEA  AppScope
	GLOBAL   AppScope
}

func GetAppScopeEnum added in v0.0.53

func GetAppScopeEnum() AppScopeEnum

type AppState added in v0.0.53

type AppState struct {

	// 状态 - ACTIVATION:开启 - DEACTIVATION:停用 - ARREARS:欠费 - DELETED:已删除
	State *AppStateState `json:"state,omitempty"`

	// app鉴权的更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`
}

app状态信息

func (AppState) String added in v0.0.53

func (o AppState) String() string

type AppStateState added in v0.0.53

type AppStateState struct {
	// contains filtered or unexported fields
}

func (AppStateState) MarshalJSON added in v0.0.53

func (c AppStateState) MarshalJSON() ([]byte, error)

func (*AppStateState) UnmarshalJSON added in v0.0.53

func (c *AppStateState) UnmarshalJSON(b []byte) error

func (AppStateState) Value added in v0.0.90

func (c AppStateState) Value() string

type AppStateStateEnum added in v0.0.53

type AppStateStateEnum struct {
	ACTIVATION   AppStateState
	DEACTIVATION AppStateState
	ARREARS      AppStateState
	DELETED      AppStateState
}

func GetAppStateStateEnum added in v0.0.53

func GetAppStateStateEnum() AppStateStateEnum

type AutoRecordModeReq added in v0.0.53

type AutoRecordModeReq struct {

	// 录制模式。 - AUTO_RECORD_OFF:关闭自动录制。 - AUTO_INDIVIDUAL_RECORD:开启单流自动录制,此时record_rule_id必须非空。
	Mode AutoRecordModeReqMode `json:"mode"`

	// 录制规则id。
	RecordRuleId *string `json:"record_rule_id,omitempty"`
}

配置app自动录制模式请求

func (AutoRecordModeReq) String added in v0.0.53

func (o AutoRecordModeReq) String() string

type AutoRecordModeReqMode added in v0.0.53

type AutoRecordModeReqMode struct {
	// contains filtered or unexported fields
}

func (AutoRecordModeReqMode) MarshalJSON added in v0.0.53

func (c AutoRecordModeReqMode) MarshalJSON() ([]byte, error)

func (*AutoRecordModeReqMode) UnmarshalJSON added in v0.0.53

func (c *AutoRecordModeReqMode) UnmarshalJSON(b []byte) error

func (AutoRecordModeReqMode) Value added in v0.0.90

func (c AutoRecordModeReqMode) Value() string

type AutoRecordModeReqModeEnum added in v0.0.53

type AutoRecordModeReqModeEnum struct {
	AUTO_RECORD_OFF        AutoRecordModeReqMode
	AUTO_INDIVIDUAL_RECORD AutoRecordModeReqMode
}

func GetAutoRecordModeReqModeEnum added in v0.0.53

func GetAutoRecordModeReqModeEnum() AutoRecordModeReqModeEnum

type CreateAppRequest added in v0.0.53

type CreateAppRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	Body *AppReq `json:"body,omitempty"`
}

Request Object

func (CreateAppRequest) String added in v0.0.53

func (o CreateAppRequest) String() string

type CreateAppResponse added in v0.0.53

type CreateAppResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateAppResponse) String added in v0.0.53

func (o CreateAppResponse) String() string

type CreateIndividualStreamJobRequest

type CreateIndividualStreamJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	Body *IndividualStreamJobReq `json:"body,omitempty"`
}

Request Object

func (CreateIndividualStreamJobRequest) String

type CreateIndividualStreamJobResponse

type CreateIndividualStreamJobResponse struct {

	// 任务编号
	JobId *string `json:"job_id,omitempty"`

	// 流名
	StreamName *string `json:"stream_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	// 房间id
	RoomId *string `json:"room_id,omitempty"`

	// 选看的用户id,单个录制任务内保证唯一
	UserId *string `json:"user_id,omitempty"`

	//  是否录制音频。  - true:录制音频 - false:不录制音频  缺省为true。
	IsRecordAudio *bool `json:"is_record_audio,omitempty"`

	// 标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。  - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流  默认为CAMERASTREAM。
	VideoType *CreateIndividualStreamJobResponseVideoType `json:"video_type,omitempty"`

	// 指定窗口拉取的分辨率档位。  - LD - SD - HD - FHD  缺省为FHD。
	SelectStreamType *CreateIndividualStreamJobResponseSelectStreamType `json:"select_stream_type,omitempty"`

	// 最长空闲频道时间。  取值范围:[5,43200],默认值为30。  单位:秒。  如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。  连麦方指:joiner或者publisher的用户。
	MaxIdleTime *int32 `json:"max_idle_time,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	// 任务状态。  - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
	State *CreateIndividualStreamJobResponseState `json:"state,omitempty"`

	// 任务结束原因
	StopReason *CreateIndividualStreamJobResponseStopReason `json:"stop_reason,omitempty"`

	// 针对任务状态的详细信息描述
	Description *string `json:"description,omitempty"`

	// 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StartTime *string `json:"start_time,omitempty"`

	// 任务完成时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StopTime *string `json:"stop_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateIndividualStreamJobResponse) String

type CreateIndividualStreamJobResponseSelectStreamType

type CreateIndividualStreamJobResponseSelectStreamType struct {
	// contains filtered or unexported fields
}

func (CreateIndividualStreamJobResponseSelectStreamType) MarshalJSON

func (*CreateIndividualStreamJobResponseSelectStreamType) UnmarshalJSON

func (CreateIndividualStreamJobResponseSelectStreamType) Value added in v0.0.90

type CreateIndividualStreamJobResponseState

type CreateIndividualStreamJobResponseState struct {
	// contains filtered or unexported fields
}

func (CreateIndividualStreamJobResponseState) MarshalJSON

func (c CreateIndividualStreamJobResponseState) MarshalJSON() ([]byte, error)

func (*CreateIndividualStreamJobResponseState) UnmarshalJSON

func (c *CreateIndividualStreamJobResponseState) UnmarshalJSON(b []byte) error

func (CreateIndividualStreamJobResponseState) Value added in v0.0.90

type CreateIndividualStreamJobResponseStopReason

type CreateIndividualStreamJobResponseStopReason struct {
	// contains filtered or unexported fields
}

func (CreateIndividualStreamJobResponseStopReason) MarshalJSON

func (*CreateIndividualStreamJobResponseStopReason) UnmarshalJSON

func (CreateIndividualStreamJobResponseStopReason) Value added in v0.0.90

type CreateIndividualStreamJobResponseStopReasonEnum

type CreateIndividualStreamJobResponseStopReasonEnum struct {
	TENANT_STOP          CreateIndividualStreamJobResponseStopReason
	EXCEED_MAX_IDLE_TIME CreateIndividualStreamJobResponseStopReason
	INTERNAL_ERROR       CreateIndividualStreamJobResponseStopReason
}

func GetCreateIndividualStreamJobResponseStopReasonEnum

func GetCreateIndividualStreamJobResponseStopReasonEnum() CreateIndividualStreamJobResponseStopReasonEnum

type CreateIndividualStreamJobResponseVideoType

type CreateIndividualStreamJobResponseVideoType struct {
	// contains filtered or unexported fields
}

func (CreateIndividualStreamJobResponseVideoType) MarshalJSON

func (*CreateIndividualStreamJobResponseVideoType) UnmarshalJSON

func (CreateIndividualStreamJobResponseVideoType) Value added in v0.0.90

type CreateMixJobRequest

type CreateMixJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	Body *MixJobReq `json:"body,omitempty"`
}

Request Object

func (CreateMixJobRequest) String

func (o CreateMixJobRequest) String() string

type CreateMixJobResponse

type CreateMixJobResponse struct {

	// 任务编号,可以用于修改、查看和停止合流任务
	JobId *string `json:"job_id,omitempty"`

	// 流名
	StreamName *string `json:"stream_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	// 房间id
	RoomId *string `json:"room_id,omitempty"`

	MixParam *MixParam `json:"mix_param,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`

	// 任务创建的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 任务中的布局更新的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	// 任务状态。  - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
	State *CreateMixJobResponseState `json:"state,omitempty"`

	// 任务结束原因
	StopReason *CreateMixJobResponseStopReason `json:"stop_reason,omitempty"`

	// 状态描述,对state字段的一些补充说明,可用于人工查阅。
	Description *string `json:"description,omitempty"`

	// 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StartTime *string `json:"start_time,omitempty"`

	// 任务结束时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StopTime *string `json:"stop_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateMixJobResponse) String

func (o CreateMixJobResponse) String() string

type CreateMixJobResponseState

type CreateMixJobResponseState struct {
	// contains filtered or unexported fields
}

func (CreateMixJobResponseState) MarshalJSON

func (c CreateMixJobResponseState) MarshalJSON() ([]byte, error)

func (*CreateMixJobResponseState) UnmarshalJSON

func (c *CreateMixJobResponseState) UnmarshalJSON(b []byte) error

func (CreateMixJobResponseState) Value added in v0.0.90

type CreateMixJobResponseStateEnum

type CreateMixJobResponseStateEnum struct {
	INIT    CreateMixJobResponseState
	RUNNING CreateMixJobResponseState
	STOPPED CreateMixJobResponseState
}

func GetCreateMixJobResponseStateEnum

func GetCreateMixJobResponseStateEnum() CreateMixJobResponseStateEnum

type CreateMixJobResponseStopReason

type CreateMixJobResponseStopReason struct {
	// contains filtered or unexported fields
}

func (CreateMixJobResponseStopReason) MarshalJSON

func (c CreateMixJobResponseStopReason) MarshalJSON() ([]byte, error)

func (*CreateMixJobResponseStopReason) UnmarshalJSON

func (c *CreateMixJobResponseStopReason) UnmarshalJSON(b []byte) error

func (CreateMixJobResponseStopReason) Value added in v0.0.90

type CreateMixJobResponseStopReasonEnum

type CreateMixJobResponseStopReasonEnum struct {
	TENANT_STOP          CreateMixJobResponseStopReason
	EXCEED_MAX_IDLE_TIME CreateMixJobResponseStopReason
	INTERNAL_ERROR       CreateMixJobResponseStopReason
}

func GetCreateMixJobResponseStopReasonEnum

func GetCreateMixJobResponseStopReasonEnum() CreateMixJobResponseStopReasonEnum

type CreateRecordRuleRequest added in v0.0.53

type CreateRecordRuleRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	Body *RecordRuleReq `json:"body,omitempty"`
}

Request Object

func (CreateRecordRuleRequest) String added in v0.0.53

func (o CreateRecordRuleRequest) String() string

type CreateRecordRuleResponse added in v0.0.53

type CreateRecordRuleResponse struct {

	// 规则id,由服务端返回。创建或修改规则的时候不携带
	RuleId *string `json:"rule_id,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	ObsAddr *RecordObsFileAddr `json:"obs_addr,omitempty"`

	// 录制格式:hls格式或者mp4格式
	RecordFormats *[]CreateRecordRuleResponseRecordFormats `json:"record_formats,omitempty"`

	HlsConfig *HlsRecordConfig `json:"hls_config,omitempty"`

	Mp4Config *Mp4RecordConfig `json:"mp4_config,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (CreateRecordRuleResponse) String added in v0.0.53

func (o CreateRecordRuleResponse) String() string

type CreateRecordRuleResponseRecordFormats added in v0.0.53

type CreateRecordRuleResponseRecordFormats struct {
	// contains filtered or unexported fields
}

func (CreateRecordRuleResponseRecordFormats) MarshalJSON added in v0.0.53

func (c CreateRecordRuleResponseRecordFormats) MarshalJSON() ([]byte, error)

func (*CreateRecordRuleResponseRecordFormats) UnmarshalJSON added in v0.0.53

func (c *CreateRecordRuleResponseRecordFormats) UnmarshalJSON(b []byte) error

func (CreateRecordRuleResponseRecordFormats) Value added in v0.0.90

type CreateRecordRuleResponseRecordFormatsEnum added in v0.0.53

type CreateRecordRuleResponseRecordFormatsEnum struct {
	HLS CreateRecordRuleResponseRecordFormats
	MP4 CreateRecordRuleResponseRecordFormats
}

func GetCreateRecordRuleResponseRecordFormatsEnum added in v0.0.53

func GetCreateRecordRuleResponseRecordFormatsEnum() CreateRecordRuleResponseRecordFormatsEnum

type DeleteAppRequest added in v0.0.53

type DeleteAppRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (DeleteAppRequest) String added in v0.0.53

func (o DeleteAppRequest) String() string

type DeleteAppResponse added in v0.0.53

type DeleteAppResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (DeleteAppResponse) String added in v0.0.53

func (o DeleteAppResponse) String() string

type DeleteRecordRuleRequest added in v0.0.53

type DeleteRecordRuleRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 规则id
	RuleId string `json:"rule_id"`
}

Request Object

func (DeleteRecordRuleRequest) String added in v0.0.53

func (o DeleteRecordRuleRequest) String() string

type DeleteRecordRuleResponse added in v0.0.53

type DeleteRecordRuleResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (DeleteRecordRuleResponse) String added in v0.0.53

func (o DeleteRecordRuleResponse) String() string

type HlsRecordConfig added in v0.0.53

type HlsRecordConfig struct {

	//  周期录制时长。  取值范围:[60,43200]或者0,如果为0则整个流录制为一个文件。  单位:秒。
	RecordCycle int32 `json:"record_cycle"`

	// 录制m3u8文件含路径和文件名的前缀  默认{app_id}/{record_format}/{stream}\\_{file_start_time}/{stream}\\_{file_start_time}  上述特殊变量含义: - {app_id}:应用id - {record_format}:录制格式 - {stream}:流名 - {file_start_time}:文件生成时间
	RecordPrefix *string `json:"record_prefix,omitempty"`

	//  录制HLS时ts的切片时长,非必填。  取值范围:[2,60],缺省为10。  单位:秒。
	RecordSliceDuration *int32 `json:"record_slice_duration,omitempty"`

	// 录制HLS文件拼接时长,如果流中断超过该时间,则生成新文件。  取值范围:[-1,300],缺省为0。  单位:秒。  - 如果为0表示流中断就生成新文件。 - 如果为-1则表示流中断恢复后追加到原来的文件中(相隔不超过30天)。
	RecordMaxDurationToMergeFile *int32 `json:"record_max_duration_to_merge_file,omitempty"`
}

func (HlsRecordConfig) String added in v0.0.53

func (o HlsRecordConfig) String() string

type IndividualStreamJobReq

type IndividualStreamJobReq struct {

	// 房间id
	RoomId string `json:"room_id"`

	// 选看的用户id,单个录制任务内保证唯一
	UserId string `json:"user_id"`

	//  是否录制音频。  - true:录制音频 - false:不录制音频  缺省为true。
	IsRecordAudio *bool `json:"is_record_audio,omitempty"`

	// 标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。  - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流  默认为CAMERASTREAM。
	VideoType *IndividualStreamJobReqVideoType `json:"video_type,omitempty"`

	// 指定窗口拉取的分辨率档位。  - LD - SD - HD - FHD  缺省为FHD。
	SelectStreamType *IndividualStreamJobReqSelectStreamType `json:"select_stream_type,omitempty"`

	// 最长空闲频道时间。  取值范围:[5,43200],默认值为30。  单位:秒。  如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。  连麦方指:joiner或者publisher的用户。
	MaxIdleTime *int32 `json:"max_idle_time,omitempty"`

	PublishParam *PublishParam `json:"publish_param,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`
}

单流任务请求,转推和录制至少选一个

func (IndividualStreamJobReq) String

func (o IndividualStreamJobReq) String() string

type IndividualStreamJobReqSelectStreamType

type IndividualStreamJobReqSelectStreamType struct {
	// contains filtered or unexported fields
}

func (IndividualStreamJobReqSelectStreamType) MarshalJSON

func (c IndividualStreamJobReqSelectStreamType) MarshalJSON() ([]byte, error)

func (*IndividualStreamJobReqSelectStreamType) UnmarshalJSON

func (c *IndividualStreamJobReqSelectStreamType) UnmarshalJSON(b []byte) error

func (IndividualStreamJobReqSelectStreamType) Value added in v0.0.90

type IndividualStreamJobReqVideoType

type IndividualStreamJobReqVideoType struct {
	// contains filtered or unexported fields
}

func (IndividualStreamJobReqVideoType) MarshalJSON

func (c IndividualStreamJobReqVideoType) MarshalJSON() ([]byte, error)

func (*IndividualStreamJobReqVideoType) UnmarshalJSON

func (c *IndividualStreamJobReqVideoType) UnmarshalJSON(b []byte) error

func (IndividualStreamJobReqVideoType) Value added in v0.0.90

type IndividualStreamJobReqVideoTypeEnum

type IndividualStreamJobReqVideoTypeEnum struct {
	CAMERASTREAM IndividualStreamJobReqVideoType
	SCREENSTREAM IndividualStreamJobReqVideoType
}

func GetIndividualStreamJobReqVideoTypeEnum

func GetIndividualStreamJobReqVideoTypeEnum() IndividualStreamJobReqVideoTypeEnum

type ListAppsRequest added in v0.0.53

type ListAppsRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用的状态:  - ACTIVATION:应用开启  - DEACTIVATION:应用停用  - ARREARS:应用欠费
	State *ListAppsRequestState `json:"state,omitempty"`

	// 查询结果起始编号,此处代表分页的页码,默认为0。
	Offset *int32 `json:"offset,omitempty"`

	// 查询结果集数量,此处代表每一页的条数,最小为1,最大为100。默认为100。
	Limit *int32 `json:"limit,omitempty"`
}

Request Object

func (ListAppsRequest) String added in v0.0.53

func (o ListAppsRequest) String() string

type ListAppsRequestState added in v0.0.53

type ListAppsRequestState struct {
	// contains filtered or unexported fields
}

func (ListAppsRequestState) MarshalJSON added in v0.0.53

func (c ListAppsRequestState) MarshalJSON() ([]byte, error)

func (*ListAppsRequestState) UnmarshalJSON added in v0.0.53

func (c *ListAppsRequestState) UnmarshalJSON(b []byte) error

func (ListAppsRequestState) Value added in v0.0.90

func (c ListAppsRequestState) Value() string

type ListAppsRequestStateEnum added in v0.0.53

type ListAppsRequestStateEnum struct {
	ACTIVATION   ListAppsRequestState
	DEACTIVATION ListAppsRequestState
	ARREARS      ListAppsRequestState
}

func GetListAppsRequestStateEnum added in v0.0.53

func GetListAppsRequestStateEnum() ListAppsRequestStateEnum

type ListAppsResponse added in v0.0.53

type ListAppsResponse struct {

	// app的总数
	Count *int32 `json:"count,omitempty"`

	// app的列表
	Apps *[]App `json:"apps,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ListAppsResponse) String added in v0.0.53

func (o ListAppsResponse) String() string

type ListRecordRulesRequest added in v0.0.53

type ListRecordRulesRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 查询结果起始编号,此处代表分页的页码
	Offset *int32 `json:"offset,omitempty"`

	// 查询结果集数量,此处代表每一页的条数
	Limit *int32 `json:"limit,omitempty"`
}

Request Object

func (ListRecordRulesRequest) String added in v0.0.53

func (o ListRecordRulesRequest) String() string

type ListRecordRulesResponse added in v0.0.53

type ListRecordRulesResponse struct {

	// 录制规则列表
	Rules *[]RecordRule `json:"rules,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ListRecordRulesResponse) String added in v0.0.53

func (o ListRecordRulesResponse) String() string

type MixJobReq

type MixJobReq struct {
	MixParam *MixParam `json:"mix_param"`

	PublishParam *PublishParam `json:"publish_param,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`
}

合流任务参数,转推和录制至少选一个

func (MixJobReq) String

func (o MixJobReq) String() string

type MixLayoutPane

type MixLayoutPane struct {

	// 窗口id,从1开始编号
	Id *int32 `json:"id,omitempty"`

	// 加入房间的用户id
	UserId *string `json:"user_id,omitempty"`

	// 标识视频流的类型,可选摄像头流或者屏幕分享流。  - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流  默认为CAMERASTREAM。
	VideoType *MixLayoutPaneVideoType `json:"video_type,omitempty"`

	// 坐标x,归一化百分比,画布上该画面左上角的横坐标的相对值,范围是 [0.0,1.0]。从左到右布局,0.0在最左端,1.0在最右端,小数取值范围在float内,自定义布局场景下填写本字段。
	X *float32 `json:"x,omitempty"`

	// 坐标y,归一化百分比,画布上该画面左上角的纵坐标的相对值,范围是 [0.0,1.0]。从上到下布局,0.0在最上端,1.0在最下端,小数取值范围在float内,自定义布局场景下填写本字段。
	Y *float32 `json:"y,omitempty"`

	// 窗格宽,归一化百分比,小数取值范围在float内,自定义布局场景下填写本字段。
	Width *float32 `json:"width,omitempty"`

	// 窗格宽,归一化百分比,小数取值范围在float内,自定义布局场景下填写本字段。
	Height *float32 `json:"height,omitempty"`

	// 叠放顺序,0为最底层,1层在0层之上,以此类推,最大支持25层,自定义布局场景下填写本字段。
	Zorder *int32 `json:"zorder,omitempty"`

	// 裁剪模式,自定义布局场景下填写本字段,支持两种模式:   - KEEP_RATIO_PADDING :保持比例留边。   - KEEP_RATIO_CROP :保持比例裁剪。
	CropMode *MixLayoutPaneCropMode `json:"crop_mode,omitempty"`

	// 填充策略,仅限屏幕共享模板(包括screen_share_right、screen_share_left)场景下填写本字段,支持两种模式:   - FIXED_USER :固定用户填充。   - SHARED_SCREEN :共享屏幕填充。
	FillingPolicy *MixLayoutPaneFillingPolicy `json:"filling_policy,omitempty"`
}

录制视频混流参数。 用法如下: 如果某窗格需要展示某个固定用户的视频: 例如:{ \"id\": 1, \"user_id\": \"user001\", \"video_type\": \"CAMERASTREAM\" } 如果某窗格需要展示某个固定用户的共享屏幕: 例如:{ \"id\": 1, \"user_id\": \"user001\", \"video_type\": \"SCREENSTREAM\" } 如果某窗格需要展示共享桌面,不特定用户: 例如:{ \"id\": 1, \"video_type\": \"SCREENSTREAM\"}

func (MixLayoutPane) String

func (o MixLayoutPane) String() string

type MixLayoutPaneCropMode

type MixLayoutPaneCropMode struct {
	// contains filtered or unexported fields
}

func (MixLayoutPaneCropMode) MarshalJSON

func (c MixLayoutPaneCropMode) MarshalJSON() ([]byte, error)

func (*MixLayoutPaneCropMode) UnmarshalJSON

func (c *MixLayoutPaneCropMode) UnmarshalJSON(b []byte) error

func (MixLayoutPaneCropMode) Value added in v0.0.90

func (c MixLayoutPaneCropMode) Value() string

type MixLayoutPaneCropModeEnum

type MixLayoutPaneCropModeEnum struct {
	KEEP_RATIO_PADDING MixLayoutPaneCropMode
	KEEP_RATIO_CROP    MixLayoutPaneCropMode
}

func GetMixLayoutPaneCropModeEnum

func GetMixLayoutPaneCropModeEnum() MixLayoutPaneCropModeEnum

type MixLayoutPaneFillingPolicy added in v0.0.97

type MixLayoutPaneFillingPolicy struct {
	// contains filtered or unexported fields
}

func (MixLayoutPaneFillingPolicy) MarshalJSON added in v0.0.97

func (c MixLayoutPaneFillingPolicy) MarshalJSON() ([]byte, error)

func (*MixLayoutPaneFillingPolicy) UnmarshalJSON added in v0.0.97

func (c *MixLayoutPaneFillingPolicy) UnmarshalJSON(b []byte) error

func (MixLayoutPaneFillingPolicy) Value added in v0.0.97

type MixLayoutPaneFillingPolicyEnum added in v0.0.97

type MixLayoutPaneFillingPolicyEnum struct {
	FIXED_USER    MixLayoutPaneFillingPolicy
	SHARED_SCREEN MixLayoutPaneFillingPolicy
}

func GetMixLayoutPaneFillingPolicyEnum added in v0.0.97

func GetMixLayoutPaneFillingPolicyEnum() MixLayoutPaneFillingPolicyEnum

type MixLayoutPaneVideoType

type MixLayoutPaneVideoType struct {
	// contains filtered or unexported fields
}

func (MixLayoutPaneVideoType) MarshalJSON

func (c MixLayoutPaneVideoType) MarshalJSON() ([]byte, error)

func (*MixLayoutPaneVideoType) UnmarshalJSON

func (c *MixLayoutPaneVideoType) UnmarshalJSON(b []byte) error

func (MixLayoutPaneVideoType) Value added in v0.0.90

func (c MixLayoutPaneVideoType) Value() string

type MixLayoutPaneVideoTypeEnum

type MixLayoutPaneVideoTypeEnum struct {
	CAMERASTREAM MixLayoutPaneVideoType
	SCREENSTREAM MixLayoutPaneVideoType
}

func GetMixLayoutPaneVideoTypeEnum

func GetMixLayoutPaneVideoTypeEnum() MixLayoutPaneVideoTypeEnum

type MixParam

type MixParam struct {

	// 房间id
	RoomId string `json:"room_id"`

	// 输出编码模板名称 - 1920x1080_30_4620:输出流是1080p,帧率30,码率4.62Mbps - 1920x1080_15_3460:输出流是1080p,帧率15,码率3.46Mbps - 1280x720_30_3420:输出流是720p,帧率30,码率3.42Mbps - 1280x720_15_2260:输出流是720p,帧率15,码率2.26Mbps
	EncodeTemplate MixParamEncodeTemplate `json:"encode_template"`

	// 最长空闲频道时间。  取值范围:[5,43200],默认值为30。  单位:秒。  如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。  连麦方指:joiner或者publisher的用户。
	MaxIdleTime *int32 `json:"max_idle_time,omitempty"`

	// 视频布局模板编号,不混视频的时候,不需要带。 - nine_grids_view:九宫格模板(自适应模板) - screen_share_left:主视图在左边的屏幕共享模板(自适应模板) - screen_share_right:主视图在右边的屏幕共享模板(自适应模板) - custom:自定义布局
	LayoutTemplate *string `json:"layout_template,omitempty"`

	// 默认用户背景图地址,图片先上传obs,格式s3://bucket/object。默认使用等比缩放裁剪,保证铺满。
	DefaultUserBackgroundImage *string `json:"default_user_background_image,omitempty"`

	// 共享屏幕的背景图地址,图片先上传obs,格式s3://bucket/object。  在一大多小的布局场景下,无论大窗是显示非指定用户(屏幕共享人的桌面)还是指定用户的共享桌面,都通过该字段指定背景图。
	ScreenBackgroundImage *string `json:"screen_background_image,omitempty"`

	// 画布背景图地址,图片先上传obs,格式s3://bucket/object。默认使用等比缩放裁剪,保证铺满。
	BackgroundImage *string `json:"background_image,omitempty"`

	// 需要混流的视频列表。若不需要混流视频,则可不传递该参数。  nine_grids_view模板不需要填写本字段。
	LayoutPanes *[]MixLayoutPane `json:"layout_panes,omitempty"`

	// 指定用户背景图,优先级大于default_user_background_image
	UserBackgroundImages *[]MixUserBackgroundImage `json:"user_background_images,omitempty"`
}

合流参数 - 纯音频录制 encode_template 填 audio_only,音频合流会动态选择最大三方的声音。 layout_template、layout_panes 以及其他视频相关参数都不填,填就忽略。 - 音视频录制(包括共享桌面) encode_template 非 audio_only,layout_template必须非空。 音频合流会动态选择最大三方的声音

func (MixParam) String

func (o MixParam) String() string

type MixParamEncodeTemplate

type MixParamEncodeTemplate struct {
	// contains filtered or unexported fields
}

func (MixParamEncodeTemplate) MarshalJSON

func (c MixParamEncodeTemplate) MarshalJSON() ([]byte, error)

func (*MixParamEncodeTemplate) UnmarshalJSON

func (c *MixParamEncodeTemplate) UnmarshalJSON(b []byte) error

func (MixParamEncodeTemplate) Value added in v0.0.90

func (c MixParamEncodeTemplate) Value() string

type MixParamEncodeTemplateEnum

type MixParamEncodeTemplateEnum struct {
	E_1920X1080_30_4620 MixParamEncodeTemplate
	E_1920X1080_15_3460 MixParamEncodeTemplate
	E_1280X720_30_3420  MixParamEncodeTemplate
	E_1280X720_15_2260  MixParamEncodeTemplate
}

func GetMixParamEncodeTemplateEnum

func GetMixParamEncodeTemplateEnum() MixParamEncodeTemplateEnum

type MixUserBackgroundImage

type MixUserBackgroundImage struct {

	// 需要设置背景图的用户ID
	UserId string `json:"user_id"`

	// 需要设置背景图的地址,图片先上传obs,格式s3://bucket/object
	ImageUri string `json:"image_uri"`
}

指定用户的背景图,优先级大于default_user_background_image

func (MixUserBackgroundImage) String

func (o MixUserBackgroundImage) String() string

type Mp4RecordConfig added in v0.0.53

type Mp4RecordConfig struct {

	//  周期录制时长。  取值范围:[60,10800]。  单位:秒。
	RecordCycle int32 `json:"record_cycle"`

	// 录制文件含路径和文件名的前缀。  默认{app_id}/{record_format}/{stream}\\_{file_start_time}/{stream}\\_{file_start_time}  上述特殊变量含义: - {app_id}:应用id - {record_format}:录制格式 - {stream}:流名 - {file_start_time}:文件生成时间
	RecordPrefix *string `json:"record_prefix,omitempty"`

	// 录制MP4拼接时长,如果流中断超过该时间,则生成新文件。  取值范围:[0,300],缺省为0。  单位:秒。  如果为0表示流中断就生成新文件。
	RecordMaxDurationToMergeFile *int32 `json:"record_max_duration_to_merge_file,omitempty"`
}

func (Mp4RecordConfig) String added in v0.0.53

func (o Mp4RecordConfig) String() string

type PublishParam

type PublishParam struct {

	// 合流任务完成后,转推的RTMP推流地址。
	RtmpUrls []string `json:"rtmp_urls"`
}

转推参数

func (PublishParam) String

func (o PublishParam) String() string

type RecordObsFileAddr added in v0.0.53

type RecordObsFileAddr struct {

	// OBS Bucket所在RegionID
	Location RecordObsFileAddrLocation `json:"location"`

	// OBS Bucket所在Region的项目ID
	ProjectId string `json:"project_id"`

	// OBS的bucket名称
	Bucket string `json:"bucket"`

	// OBS对象路径,遵守OBS Object定义。如果为空则保存到根目录
	Object *string `json:"object,omitempty"`
}

func (RecordObsFileAddr) String added in v0.0.53

func (o RecordObsFileAddr) String() string

type RecordObsFileAddrLocation added in v0.0.53

type RecordObsFileAddrLocation struct {
	// contains filtered or unexported fields
}

func (RecordObsFileAddrLocation) MarshalJSON added in v0.0.53

func (c RecordObsFileAddrLocation) MarshalJSON() ([]byte, error)

func (*RecordObsFileAddrLocation) UnmarshalJSON added in v0.0.53

func (c *RecordObsFileAddrLocation) UnmarshalJSON(b []byte) error

func (RecordObsFileAddrLocation) Value added in v0.0.90

type RecordObsFileAddrLocationEnum added in v0.0.53

type RecordObsFileAddrLocationEnum struct {
	CN_NORTH_4 RecordObsFileAddrLocation
}

func GetRecordObsFileAddrLocationEnum added in v0.0.53

func GetRecordObsFileAddrLocationEnum() RecordObsFileAddrLocationEnum

type RecordParam

type RecordParam struct {

	// 录制规则id。
	RecordRuleId string `json:"record_rule_id"`
}

录制参数

func (RecordParam) String

func (o RecordParam) String() string

type RecordRule added in v0.0.53

type RecordRule struct {

	// 规则id,由服务端返回。创建或修改规则的时候不携带
	RuleId *string `json:"rule_id,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	ObsAddr *RecordObsFileAddr `json:"obs_addr,omitempty"`

	// 录制格式:hls格式或者mp4格式
	RecordFormats *[]RecordRuleRecordFormats `json:"record_formats,omitempty"`

	HlsConfig *HlsRecordConfig `json:"hls_config,omitempty"`

	Mp4Config *Mp4RecordConfig `json:"mp4_config,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`
}

创建状态回调请求体

func (RecordRule) String added in v0.0.53

func (o RecordRule) String() string

type RecordRuleRecordFormats added in v0.0.53

type RecordRuleRecordFormats struct {
	// contains filtered or unexported fields
}

func (RecordRuleRecordFormats) MarshalJSON added in v0.0.53

func (c RecordRuleRecordFormats) MarshalJSON() ([]byte, error)

func (*RecordRuleRecordFormats) UnmarshalJSON added in v0.0.53

func (c *RecordRuleRecordFormats) UnmarshalJSON(b []byte) error

func (RecordRuleRecordFormats) Value added in v0.0.90

func (c RecordRuleRecordFormats) Value() string

type RecordRuleRecordFormatsEnum added in v0.0.53

type RecordRuleRecordFormatsEnum struct {
	HLS RecordRuleRecordFormats
	MP4 RecordRuleRecordFormats
}

func GetRecordRuleRecordFormatsEnum added in v0.0.53

func GetRecordRuleRecordFormatsEnum() RecordRuleRecordFormatsEnum

type RecordRuleReq added in v0.0.53

type RecordRuleReq struct {
	ObsAddr *RecordObsFileAddr `json:"obs_addr"`

	//  录制格式:支持HLS格式和MP4格式(HLS和MP4为大写)。   - 若配置HLS则必须携带HLSRecordConfig参数  - 若配置MP4则需要携带MP4RecordConfig
	RecordFormats []RecordRuleReqRecordFormats `json:"record_formats"`

	HlsConfig *HlsRecordConfig `json:"hls_config,omitempty"`

	Mp4Config *Mp4RecordConfig `json:"mp4_config,omitempty"`
}

修改录制规则

func (RecordRuleReq) String added in v0.0.53

func (o RecordRuleReq) String() string

type RecordRuleReqRecordFormats added in v0.0.53

type RecordRuleReqRecordFormats struct {
	// contains filtered or unexported fields
}

func (RecordRuleReqRecordFormats) MarshalJSON added in v0.0.53

func (c RecordRuleReqRecordFormats) MarshalJSON() ([]byte, error)

func (*RecordRuleReqRecordFormats) UnmarshalJSON added in v0.0.53

func (c *RecordRuleReqRecordFormats) UnmarshalJSON(b []byte) error

func (RecordRuleReqRecordFormats) Value added in v0.0.90

type RecordRuleReqRecordFormatsEnum added in v0.0.53

type RecordRuleReqRecordFormatsEnum struct {
	HLS RecordRuleReqRecordFormats
	MP4 RecordRuleReqRecordFormats
}

func GetRecordRuleReqRecordFormatsEnum added in v0.0.53

func GetRecordRuleReqRecordFormatsEnum() RecordRuleReqRecordFormatsEnum

type RemoveRoomRequest added in v0.1.5

type RemoveRoomRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 房间id
	RoomId string `json:"room_id"`
}

Request Object

func (RemoveRoomRequest) String added in v0.1.5

func (o RemoveRoomRequest) String() string

type RemoveRoomResponse added in v0.1.5

type RemoveRoomResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (RemoveRoomResponse) String added in v0.1.5

func (o RemoveRoomResponse) String() string

type RemoveUsersReq added in v0.1.5

type RemoveUsersReq struct {

	// 用户ID列表
	UserIds []string `json:"user_ids"`
}

func (RemoveUsersReq) String added in v0.1.5

func (o RemoveUsersReq) String() string

type RemoveUsersRequest added in v0.1.5

type RemoveUsersRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 房间id
	RoomId string `json:"room_id"`

	Body *RemoveUsersReq `json:"body,omitempty"`
}

Request Object

func (RemoveUsersRequest) String added in v0.1.5

func (o RemoveUsersRequest) String() string

type RemoveUsersResponse added in v0.1.5

type RemoveUsersResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (RemoveUsersResponse) String added in v0.1.5

func (o RemoveUsersResponse) String() string

type ShowAppRequest added in v0.0.53

type ShowAppRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (ShowAppRequest) String added in v0.0.53

func (o ShowAppRequest) String() string

type ShowAppResponse added in v0.0.53

type ShowAppResponse struct {

	// app名称
	AppName *string `json:"app_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	State *AppState `json:"state,omitempty"`

	// RTC覆盖范围。  取值如下:    - DOMESTIC:国内范围。   - OVERSEA:海外范围。   - GLOBAL:全球范围。
	Scope *ShowAppResponseScope `json:"scope,omitempty"`

	// 账号名
	TenantName *string `json:"tenant_name,omitempty"`

	// 域名,App对应域名
	Domain *string `json:"domain,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	Authentication *AppAuth `json:"authentication,omitempty"`

	Callbacks *AppCallbacks `json:"callbacks,omitempty"`

	AutoRecordMode *AppAutoRecordMode `json:"auto_record_mode,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowAppResponse) String added in v0.0.53

func (o ShowAppResponse) String() string

type ShowAppResponseScope added in v0.0.53

type ShowAppResponseScope struct {
	// contains filtered or unexported fields
}

func (ShowAppResponseScope) MarshalJSON added in v0.0.53

func (c ShowAppResponseScope) MarshalJSON() ([]byte, error)

func (*ShowAppResponseScope) UnmarshalJSON added in v0.0.53

func (c *ShowAppResponseScope) UnmarshalJSON(b []byte) error

func (ShowAppResponseScope) Value added in v0.0.90

func (c ShowAppResponseScope) Value() string

type ShowAppResponseScopeEnum added in v0.0.53

type ShowAppResponseScopeEnum struct {
	DOMESTIC ShowAppResponseScope
	OVERSEA  ShowAppResponseScope
	GLOBAL   ShowAppResponseScope
}

func GetShowAppResponseScopeEnum added in v0.0.53

func GetShowAppResponseScopeEnum() ShowAppResponseScopeEnum

type ShowAutoRecordRequest added in v0.0.53

type ShowAutoRecordRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (ShowAutoRecordRequest) String added in v0.0.53

func (o ShowAutoRecordRequest) String() string

type ShowAutoRecordResponse added in v0.0.53

type ShowAutoRecordResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	AutoRecordMode *AppAutoRecordMode `json:"auto_record_mode,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowAutoRecordResponse) String added in v0.0.53

func (o ShowAutoRecordResponse) String() string

type ShowIndividualStreamJobRequest

type ShowIndividualStreamJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 任务编号
	JobId string `json:"job_id"`
}

Request Object

func (ShowIndividualStreamJobRequest) String

type ShowIndividualStreamJobResponse

type ShowIndividualStreamJobResponse struct {

	// 任务编号
	JobId *string `json:"job_id,omitempty"`

	// 流名
	StreamName *string `json:"stream_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	// 房间id
	RoomId *string `json:"room_id,omitempty"`

	// 选看的用户id,单个录制任务内保证唯一
	UserId *string `json:"user_id,omitempty"`

	//  是否录制音频。  - true:录制音频 - false:不录制音频  缺省为true。
	IsRecordAudio *bool `json:"is_record_audio,omitempty"`

	// 标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。  - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流  默认为CAMERASTREAM。
	VideoType *ShowIndividualStreamJobResponseVideoType `json:"video_type,omitempty"`

	// 指定窗口拉取的分辨率档位。  - LD - SD - HD - FHD  缺省为FHD。
	SelectStreamType *ShowIndividualStreamJobResponseSelectStreamType `json:"select_stream_type,omitempty"`

	// 最长空闲频道时间。  取值范围:[5,43200],默认值为30。  单位:秒。  如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。  连麦方指:joiner或者publisher的用户。
	MaxIdleTime *int32 `json:"max_idle_time,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	// 任务状态。  - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
	State *ShowIndividualStreamJobResponseState `json:"state,omitempty"`

	// 任务结束原因
	StopReason *ShowIndividualStreamJobResponseStopReason `json:"stop_reason,omitempty"`

	// 针对任务状态的详细信息描述
	Description *string `json:"description,omitempty"`

	// 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StartTime *string `json:"start_time,omitempty"`

	// 任务完成时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StopTime *string `json:"stop_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowIndividualStreamJobResponse) String

type ShowIndividualStreamJobResponseSelectStreamType

type ShowIndividualStreamJobResponseSelectStreamType struct {
	// contains filtered or unexported fields
}

func (ShowIndividualStreamJobResponseSelectStreamType) MarshalJSON

func (*ShowIndividualStreamJobResponseSelectStreamType) UnmarshalJSON

func (ShowIndividualStreamJobResponseSelectStreamType) Value added in v0.0.90

type ShowIndividualStreamJobResponseState

type ShowIndividualStreamJobResponseState struct {
	// contains filtered or unexported fields
}

func (ShowIndividualStreamJobResponseState) MarshalJSON

func (c ShowIndividualStreamJobResponseState) MarshalJSON() ([]byte, error)

func (*ShowIndividualStreamJobResponseState) UnmarshalJSON

func (c *ShowIndividualStreamJobResponseState) UnmarshalJSON(b []byte) error

func (ShowIndividualStreamJobResponseState) Value added in v0.0.90

type ShowIndividualStreamJobResponseStopReason

type ShowIndividualStreamJobResponseStopReason struct {
	// contains filtered or unexported fields
}

func (ShowIndividualStreamJobResponseStopReason) MarshalJSON

func (*ShowIndividualStreamJobResponseStopReason) UnmarshalJSON

func (ShowIndividualStreamJobResponseStopReason) Value added in v0.0.90

type ShowIndividualStreamJobResponseStopReasonEnum

type ShowIndividualStreamJobResponseStopReasonEnum struct {
	TENANT_STOP          ShowIndividualStreamJobResponseStopReason
	EXCEED_MAX_IDLE_TIME ShowIndividualStreamJobResponseStopReason
	INTERNAL_ERROR       ShowIndividualStreamJobResponseStopReason
}

func GetShowIndividualStreamJobResponseStopReasonEnum

func GetShowIndividualStreamJobResponseStopReasonEnum() ShowIndividualStreamJobResponseStopReasonEnum

type ShowIndividualStreamJobResponseVideoType

type ShowIndividualStreamJobResponseVideoType struct {
	// contains filtered or unexported fields
}

func (ShowIndividualStreamJobResponseVideoType) MarshalJSON

func (*ShowIndividualStreamJobResponseVideoType) UnmarshalJSON

func (c *ShowIndividualStreamJobResponseVideoType) UnmarshalJSON(b []byte) error

func (ShowIndividualStreamJobResponseVideoType) Value added in v0.0.90

type ShowMixJobRequest

type ShowMixJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 任务编号
	JobId string `json:"job_id"`
}

Request Object

func (ShowMixJobRequest) String

func (o ShowMixJobRequest) String() string

type ShowMixJobResponse

type ShowMixJobResponse struct {

	// 任务编号,可以用于修改、查看和停止合流任务
	JobId *string `json:"job_id,omitempty"`

	// 流名
	StreamName *string `json:"stream_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	// 房间id
	RoomId *string `json:"room_id,omitempty"`

	MixParam *MixParam `json:"mix_param,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`

	// 任务创建的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 任务中的布局更新的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	// 任务状态。  - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
	State *ShowMixJobResponseState `json:"state,omitempty"`

	// 任务结束原因
	StopReason *ShowMixJobResponseStopReason `json:"stop_reason,omitempty"`

	// 状态描述,对state字段的一些补充说明,可用于人工查阅。
	Description *string `json:"description,omitempty"`

	// 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StartTime *string `json:"start_time,omitempty"`

	// 任务结束时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StopTime *string `json:"stop_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowMixJobResponse) String

func (o ShowMixJobResponse) String() string

type ShowMixJobResponseState

type ShowMixJobResponseState struct {
	// contains filtered or unexported fields
}

func (ShowMixJobResponseState) MarshalJSON

func (c ShowMixJobResponseState) MarshalJSON() ([]byte, error)

func (*ShowMixJobResponseState) UnmarshalJSON

func (c *ShowMixJobResponseState) UnmarshalJSON(b []byte) error

func (ShowMixJobResponseState) Value added in v0.0.90

func (c ShowMixJobResponseState) Value() string

type ShowMixJobResponseStateEnum

type ShowMixJobResponseStateEnum struct {
	INIT    ShowMixJobResponseState
	RUNNING ShowMixJobResponseState
	STOPPED ShowMixJobResponseState
}

func GetShowMixJobResponseStateEnum

func GetShowMixJobResponseStateEnum() ShowMixJobResponseStateEnum

type ShowMixJobResponseStopReason

type ShowMixJobResponseStopReason struct {
	// contains filtered or unexported fields
}

func (ShowMixJobResponseStopReason) MarshalJSON

func (c ShowMixJobResponseStopReason) MarshalJSON() ([]byte, error)

func (*ShowMixJobResponseStopReason) UnmarshalJSON

func (c *ShowMixJobResponseStopReason) UnmarshalJSON(b []byte) error

func (ShowMixJobResponseStopReason) Value added in v0.0.90

type ShowMixJobResponseStopReasonEnum

type ShowMixJobResponseStopReasonEnum struct {
	TENANT_STOP          ShowMixJobResponseStopReason
	EXCEED_MAX_IDLE_TIME ShowMixJobResponseStopReason
	INTERNAL_ERROR       ShowMixJobResponseStopReason
}

func GetShowMixJobResponseStopReasonEnum

func GetShowMixJobResponseStopReasonEnum() ShowMixJobResponseStopReasonEnum

type ShowRecordCallbackRequest added in v0.0.53

type ShowRecordCallbackRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (ShowRecordCallbackRequest) String added in v0.0.53

func (o ShowRecordCallbackRequest) String() string

type ShowRecordCallbackResponse added in v0.0.53

type ShowRecordCallbackResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	RecordCallback *AppCallbackUrl `json:"record_callback,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowRecordCallbackResponse) String added in v0.0.53

type ShowRecordRuleRequest added in v0.0.53

type ShowRecordRuleRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 规则id
	RuleId string `json:"rule_id"`
}

Request Object

func (ShowRecordRuleRequest) String added in v0.0.53

func (o ShowRecordRuleRequest) String() string

type ShowRecordRuleResponse added in v0.0.53

type ShowRecordRuleResponse struct {

	// 规则id,由服务端返回。创建或修改规则的时候不携带
	RuleId *string `json:"rule_id,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	ObsAddr *RecordObsFileAddr `json:"obs_addr,omitempty"`

	// 录制格式:hls格式或者mp4格式
	RecordFormats *[]ShowRecordRuleResponseRecordFormats `json:"record_formats,omitempty"`

	HlsConfig *HlsRecordConfig `json:"hls_config,omitempty"`

	Mp4Config *Mp4RecordConfig `json:"mp4_config,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowRecordRuleResponse) String added in v0.0.53

func (o ShowRecordRuleResponse) String() string

type ShowRecordRuleResponseRecordFormats added in v0.0.53

type ShowRecordRuleResponseRecordFormats struct {
	// contains filtered or unexported fields
}

func (ShowRecordRuleResponseRecordFormats) MarshalJSON added in v0.0.53

func (c ShowRecordRuleResponseRecordFormats) MarshalJSON() ([]byte, error)

func (*ShowRecordRuleResponseRecordFormats) UnmarshalJSON added in v0.0.53

func (c *ShowRecordRuleResponseRecordFormats) UnmarshalJSON(b []byte) error

func (ShowRecordRuleResponseRecordFormats) Value added in v0.0.90

type ShowRecordRuleResponseRecordFormatsEnum added in v0.0.53

type ShowRecordRuleResponseRecordFormatsEnum struct {
	HLS ShowRecordRuleResponseRecordFormats
	MP4 ShowRecordRuleResponseRecordFormats
}

func GetShowRecordRuleResponseRecordFormatsEnum added in v0.0.53

func GetShowRecordRuleResponseRecordFormatsEnum() ShowRecordRuleResponseRecordFormatsEnum

type ShowUrlAuthRequest added in v0.0.53

type ShowUrlAuthRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (ShowUrlAuthRequest) String added in v0.0.53

func (o ShowUrlAuthRequest) String() string

type ShowUrlAuthResponse added in v0.0.53

type ShowUrlAuthResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	Authentication *AppAuth `json:"authentication,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (ShowUrlAuthResponse) String added in v0.0.53

func (o ShowUrlAuthResponse) String() string

type StartAppRequest added in v0.0.53

type StartAppRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (StartAppRequest) String added in v0.0.53

func (o StartAppRequest) String() string

type StartAppResponse added in v0.0.53

type StartAppResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	State *AppState `json:"state,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (StartAppResponse) String added in v0.0.53

func (o StartAppResponse) String() string

type StopAppRequest added in v0.0.53

type StopAppRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`
}

Request Object

func (StopAppRequest) String added in v0.0.53

func (o StopAppRequest) String() string

type StopAppResponse added in v0.0.53

type StopAppResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	State *AppState `json:"state,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (StopAppResponse) String added in v0.0.53

func (o StopAppResponse) String() string

type StopIndividualStreamJobRequest

type StopIndividualStreamJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 任务ID
	JobId string `json:"job_id"`
}

Request Object

func (StopIndividualStreamJobRequest) String

type StopIndividualStreamJobResponse

type StopIndividualStreamJobResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (StopIndividualStreamJobResponse) String

type StopMixJobRequest

type StopMixJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 任务编号
	JobId string `json:"job_id"`
}

Request Object

func (StopMixJobRequest) String

func (o StopMixJobRequest) String() string

type StopMixJobResponse

type StopMixJobResponse struct {
	HttpStatusCode int `json:"-"`
}

Response Object

func (StopMixJobResponse) String

func (o StopMixJobResponse) String() string

type UpdateAutoRecordRequest added in v0.0.53

type UpdateAutoRecordRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	Body *AutoRecordModeReq `json:"body,omitempty"`
}

Request Object

func (UpdateAutoRecordRequest) String added in v0.0.53

func (o UpdateAutoRecordRequest) String() string

type UpdateAutoRecordResponse added in v0.0.53

type UpdateAutoRecordResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	AutoRecordMode *AppAutoRecordMode `json:"auto_record_mode,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateAutoRecordResponse) String added in v0.0.53

func (o UpdateAutoRecordResponse) String() string

type UpdateIndividualJobReq added in v0.1.5

type UpdateIndividualJobReq struct {
	PublishParam *PublishParam `json:"publish_param,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`
}

更新单流任务请求,转推和录制至少选一个

func (UpdateIndividualJobReq) String added in v0.1.5

func (o UpdateIndividualJobReq) String() string

type UpdateIndividualStreamJobRequest added in v0.1.5

type UpdateIndividualStreamJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 任务编号
	JobId string `json:"job_id"`

	Body *UpdateIndividualJobReq `json:"body,omitempty"`
}

Request Object

func (UpdateIndividualStreamJobRequest) String added in v0.1.5

type UpdateIndividualStreamJobResponse added in v0.1.5

type UpdateIndividualStreamJobResponse struct {

	// 任务编号
	JobId *string `json:"job_id,omitempty"`

	// 流名
	StreamName *string `json:"stream_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	// 房间id
	RoomId *string `json:"room_id,omitempty"`

	// 选看的用户id,单个录制任务内保证唯一
	UserId *string `json:"user_id,omitempty"`

	//  是否录制音频。  - true:录制音频 - false:不录制音频  缺省为true。
	IsRecordAudio *bool `json:"is_record_audio,omitempty"`

	// 标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。  - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流  默认为CAMERASTREAM。
	VideoType *UpdateIndividualStreamJobResponseVideoType `json:"video_type,omitempty"`

	// 指定窗口拉取的分辨率档位。  - LD - SD - HD - FHD  缺省为FHD。
	SelectStreamType *UpdateIndividualStreamJobResponseSelectStreamType `json:"select_stream_type,omitempty"`

	// 最长空闲频道时间。  取值范围:[5,43200],默认值为30。  单位:秒。  如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。  连麦方指:joiner或者publisher的用户。
	MaxIdleTime *int32 `json:"max_idle_time,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	// 任务状态。  - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
	State *UpdateIndividualStreamJobResponseState `json:"state,omitempty"`

	// 任务结束原因
	StopReason *UpdateIndividualStreamJobResponseStopReason `json:"stop_reason,omitempty"`

	// 针对任务状态的详细信息描述
	Description *string `json:"description,omitempty"`

	// 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StartTime *string `json:"start_time,omitempty"`

	// 任务完成时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StopTime *string `json:"stop_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateIndividualStreamJobResponse) String added in v0.1.5

type UpdateIndividualStreamJobResponseSelectStreamType added in v0.1.5

type UpdateIndividualStreamJobResponseSelectStreamType struct {
	// contains filtered or unexported fields
}

func (UpdateIndividualStreamJobResponseSelectStreamType) MarshalJSON added in v0.1.5

func (*UpdateIndividualStreamJobResponseSelectStreamType) UnmarshalJSON added in v0.1.5

func (UpdateIndividualStreamJobResponseSelectStreamType) Value added in v0.1.5

type UpdateIndividualStreamJobResponseState added in v0.1.5

type UpdateIndividualStreamJobResponseState struct {
	// contains filtered or unexported fields
}

func (UpdateIndividualStreamJobResponseState) MarshalJSON added in v0.1.5

func (c UpdateIndividualStreamJobResponseState) MarshalJSON() ([]byte, error)

func (*UpdateIndividualStreamJobResponseState) UnmarshalJSON added in v0.1.5

func (c *UpdateIndividualStreamJobResponseState) UnmarshalJSON(b []byte) error

func (UpdateIndividualStreamJobResponseState) Value added in v0.1.5

type UpdateIndividualStreamJobResponseStateEnum added in v0.1.5

type UpdateIndividualStreamJobResponseStateEnum struct {
	INIT    UpdateIndividualStreamJobResponseState
	RUNNING UpdateIndividualStreamJobResponseState
	STOPPED UpdateIndividualStreamJobResponseState
}

func GetUpdateIndividualStreamJobResponseStateEnum added in v0.1.5

func GetUpdateIndividualStreamJobResponseStateEnum() UpdateIndividualStreamJobResponseStateEnum

type UpdateIndividualStreamJobResponseStopReason added in v0.1.5

type UpdateIndividualStreamJobResponseStopReason struct {
	// contains filtered or unexported fields
}

func (UpdateIndividualStreamJobResponseStopReason) MarshalJSON added in v0.1.5

func (*UpdateIndividualStreamJobResponseStopReason) UnmarshalJSON added in v0.1.5

func (UpdateIndividualStreamJobResponseStopReason) Value added in v0.1.5

type UpdateIndividualStreamJobResponseStopReasonEnum added in v0.1.5

type UpdateIndividualStreamJobResponseStopReasonEnum struct {
	TENANT_STOP          UpdateIndividualStreamJobResponseStopReason
	EXCEED_MAX_IDLE_TIME UpdateIndividualStreamJobResponseStopReason
	INTERNAL_ERROR       UpdateIndividualStreamJobResponseStopReason
}

func GetUpdateIndividualStreamJobResponseStopReasonEnum added in v0.1.5

func GetUpdateIndividualStreamJobResponseStopReasonEnum() UpdateIndividualStreamJobResponseStopReasonEnum

type UpdateIndividualStreamJobResponseVideoType added in v0.1.5

type UpdateIndividualStreamJobResponseVideoType struct {
	// contains filtered or unexported fields
}

func (UpdateIndividualStreamJobResponseVideoType) MarshalJSON added in v0.1.5

func (*UpdateIndividualStreamJobResponseVideoType) UnmarshalJSON added in v0.1.5

func (UpdateIndividualStreamJobResponseVideoType) Value added in v0.1.5

type UpdateIndividualStreamJobResponseVideoTypeEnum added in v0.1.5

type UpdateIndividualStreamJobResponseVideoTypeEnum struct {
	CAMERASTREAM UpdateIndividualStreamJobResponseVideoType
	SCREENSTREAM UpdateIndividualStreamJobResponseVideoType
	EMPTY        UpdateIndividualStreamJobResponseVideoType
}

func GetUpdateIndividualStreamJobResponseVideoTypeEnum added in v0.1.5

func GetUpdateIndividualStreamJobResponseVideoTypeEnum() UpdateIndividualStreamJobResponseVideoTypeEnum

type UpdateMixJobReq

type UpdateMixJobReq struct {
	MixParam *UpdateMixParam `json:"mix_param"`
}

合流任务参数

func (UpdateMixJobReq) String

func (o UpdateMixJobReq) String() string

type UpdateMixJobRequest

type UpdateMixJobRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 任务编号
	JobId string `json:"job_id"`

	Body *UpdateMixJobReq `json:"body,omitempty"`
}

Request Object

func (UpdateMixJobRequest) String

func (o UpdateMixJobRequest) String() string

type UpdateMixJobResponse

type UpdateMixJobResponse struct {

	// 任务编号,可以用于修改、查看和停止合流任务
	JobId *string `json:"job_id,omitempty"`

	// 流名
	StreamName *string `json:"stream_name,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	// 房间id
	RoomId *string `json:"room_id,omitempty"`

	MixParam *MixParam `json:"mix_param,omitempty"`

	RecordParam *RecordParam `json:"record_param,omitempty"`

	// 任务创建的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 任务中的布局更新的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	// 任务状态。  - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
	State *UpdateMixJobResponseState `json:"state,omitempty"`

	// 任务结束原因
	StopReason *UpdateMixJobResponseStopReason `json:"stop_reason,omitempty"`

	// 状态描述,对state字段的一些补充说明,可用于人工查阅。
	Description *string `json:"description,omitempty"`

	// 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StartTime *string `json:"start_time,omitempty"`

	// 任务结束时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	StopTime *string `json:"stop_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateMixJobResponse) String

func (o UpdateMixJobResponse) String() string

type UpdateMixJobResponseState

type UpdateMixJobResponseState struct {
	// contains filtered or unexported fields
}

func (UpdateMixJobResponseState) MarshalJSON

func (c UpdateMixJobResponseState) MarshalJSON() ([]byte, error)

func (*UpdateMixJobResponseState) UnmarshalJSON

func (c *UpdateMixJobResponseState) UnmarshalJSON(b []byte) error

func (UpdateMixJobResponseState) Value added in v0.0.90

type UpdateMixJobResponseStateEnum

type UpdateMixJobResponseStateEnum struct {
	INIT    UpdateMixJobResponseState
	RUNNING UpdateMixJobResponseState
	STOPPED UpdateMixJobResponseState
}

func GetUpdateMixJobResponseStateEnum

func GetUpdateMixJobResponseStateEnum() UpdateMixJobResponseStateEnum

type UpdateMixJobResponseStopReason

type UpdateMixJobResponseStopReason struct {
	// contains filtered or unexported fields
}

func (UpdateMixJobResponseStopReason) MarshalJSON

func (c UpdateMixJobResponseStopReason) MarshalJSON() ([]byte, error)

func (*UpdateMixJobResponseStopReason) UnmarshalJSON

func (c *UpdateMixJobResponseStopReason) UnmarshalJSON(b []byte) error

func (UpdateMixJobResponseStopReason) Value added in v0.0.90

type UpdateMixJobResponseStopReasonEnum

type UpdateMixJobResponseStopReasonEnum struct {
	TENANT_STOP          UpdateMixJobResponseStopReason
	EXCEED_MAX_IDLE_TIME UpdateMixJobResponseStopReason
	INTERNAL_ERROR       UpdateMixJobResponseStopReason
}

func GetUpdateMixJobResponseStopReasonEnum

func GetUpdateMixJobResponseStopReasonEnum() UpdateMixJobResponseStopReasonEnum

type UpdateMixParam

type UpdateMixParam struct {

	// 视频布局模板编号,仅支持自定义模板之间的更新。
	LayoutTemplate *string `json:"layout_template,omitempty"`

	// 画布背景图地址,图片先上传obs。默认使用等比缩放裁剪,保证铺满。格式s3://bucket/object
	BackgroundImage *string `json:"background_image,omitempty"`

	// 默认用户背景图地址,图片先上传obs,格式s3://bucket/object。默认使用等比缩放裁剪,保证铺满。
	DefaultUserBackgroundImage *string `json:"default_user_background_image,omitempty"`

	// 共享屏幕的背景图地址,图片先上传obs,格式s3://bucket/object。  在一大多小的布局场景下,无论大窗是显示非指定用户(屏幕共享人的桌面)还是指定用户的共享桌面,都通过该字段指定背景图。
	ScreenBackgroundImage *string `json:"screen_background_image,omitempty"`

	// 最长空闲频道时间。  取值范围:[5,43200],默认值为30。  单位:秒。  如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。  连麦方指:joiner或者publisher的用户。
	MaxIdleTime *int32 `json:"max_idle_time,omitempty"`

	// 需要混流的视频列表。若不需要视频混流,则可不传递该参数。
	LayoutPanes *[]MixLayoutPane `json:"layout_panes,omitempty"`

	// 指定用户背景图,优先级大于default_user_background_image
	UserBackgroundImages *[]MixUserBackgroundImage `json:"user_background_images,omitempty"`
}

可修改的合流参数

func (UpdateMixParam) String

func (o UpdateMixParam) String() string

type UpdateRecordCallbackRequest added in v0.0.53

type UpdateRecordCallbackRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	Body *AppCallbackUrlReq `json:"body,omitempty"`
}

Request Object

func (UpdateRecordCallbackRequest) String added in v0.0.53

type UpdateRecordCallbackResponse added in v0.0.53

type UpdateRecordCallbackResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	RecordCallback *AppCallbackUrl `json:"record_callback,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateRecordCallbackResponse) String added in v0.0.53

type UpdateRecordRuleRequest added in v0.0.53

type UpdateRecordRuleRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	// 规则id
	RuleId string `json:"rule_id"`

	Body *RecordRuleReq `json:"body,omitempty"`
}

Request Object

func (UpdateRecordRuleRequest) String added in v0.0.53

func (o UpdateRecordRuleRequest) String() string

type UpdateRecordRuleResponse added in v0.0.53

type UpdateRecordRuleResponse struct {

	// 规则id,由服务端返回。创建或修改规则的时候不携带
	RuleId *string `json:"rule_id,omitempty"`

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	ObsAddr *RecordObsFileAddr `json:"obs_addr,omitempty"`

	// 录制格式:hls格式或者mp4格式
	RecordFormats *[]UpdateRecordRuleResponseRecordFormats `json:"record_formats,omitempty"`

	HlsConfig *HlsRecordConfig `json:"hls_config,omitempty"`

	Mp4Config *Mp4RecordConfig `json:"mp4_config,omitempty"`

	// 创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	CreateTime *string `json:"create_time,omitempty"`

	// 更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC
	UpdateTime *string `json:"update_time,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateRecordRuleResponse) String added in v0.0.53

func (o UpdateRecordRuleResponse) String() string

type UpdateRecordRuleResponseRecordFormats added in v0.0.53

type UpdateRecordRuleResponseRecordFormats struct {
	// contains filtered or unexported fields
}

func (UpdateRecordRuleResponseRecordFormats) MarshalJSON added in v0.0.53

func (c UpdateRecordRuleResponseRecordFormats) MarshalJSON() ([]byte, error)

func (*UpdateRecordRuleResponseRecordFormats) UnmarshalJSON added in v0.0.53

func (c *UpdateRecordRuleResponseRecordFormats) UnmarshalJSON(b []byte) error

func (UpdateRecordRuleResponseRecordFormats) Value added in v0.0.90

type UpdateRecordRuleResponseRecordFormatsEnum added in v0.0.53

type UpdateRecordRuleResponseRecordFormatsEnum struct {
	HLS UpdateRecordRuleResponseRecordFormats
	MP4 UpdateRecordRuleResponseRecordFormats
}

func GetUpdateRecordRuleResponseRecordFormatsEnum added in v0.0.53

func GetUpdateRecordRuleResponseRecordFormatsEnum() UpdateRecordRuleResponseRecordFormatsEnum

type UpdateUrlAuthRequest added in v0.0.53

type UpdateUrlAuthRequest struct {

	// 使用AK/SK方式认证时必选,携带的鉴权信息。
	Authorization *string `json:"Authorization,omitempty"`

	// 使用AK/SK方式认证时必选,请求的发生时间。
	XSdkDate *string `json:"X-Sdk-Date,omitempty"`

	// 使用AK/SK方式认证时必选,携带项目ID信息。
	XProjectId *string `json:"X-Project-Id,omitempty"`

	// 应用id
	AppId string `json:"app_id"`

	Body *AppAuthReq `json:"body,omitempty"`
}

Request Object

func (UpdateUrlAuthRequest) String added in v0.0.53

func (o UpdateUrlAuthRequest) String() string

type UpdateUrlAuthResponse added in v0.0.53

type UpdateUrlAuthResponse struct {

	// 应用id
	AppId *string `json:"app_id,omitempty"`

	Authentication *AppAuth `json:"authentication,omitempty"`

	XRequestId     *string `json:"X-request-Id,omitempty"`
	HttpStatusCode int     `json:"-"`
}

Response Object

func (UpdateUrlAuthResponse) String added in v0.0.53

func (o UpdateUrlAuthResponse) String() string

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL