webrecording

Documentation

Index

• type AcquireWebRecodingClientRequest
• type Client
  • func NewClient(acquireAPI *api.Acquire, startAPI *api.Start, stopAPI *api.Stop, ...) *Client
  • func (c *Client) Acquire(ctx context.Context, cname string, uid string, ...) (*api.AcquireResp, error)
  • func (c *Client) Query(ctx context.Context, resourceID string, sid string) (*QueryWebRecordingResp, error)
  • func (c *Client) Start(ctx context.Context, resourceID string, cname string, uid string, ...) (*api.StartResp, error)
  • func (c *Client) Stop(ctx context.Context, resourceID string, sid string, cname string, uid string, ...) (*api.StopResp, error)
  • func (c *Client) Update(ctx context.Context, resourceID string, sid string, cname string, uid string, ...) (*api.UpdateResp, error)
• type QueryWebRecordingResp
• type QueryWebRecordingSuccessResp
• type StartWebRecordingClientRequest
• type UpdateWebRecordingClientRequest

Types

type AcquireWebRecodingClientRequest

type AcquireWebRecodingClientRequest struct {
	ResourceExpiredHour int      `json:"resourceExpiredHour,omitempty"`
	ExcludeResourceIds  []string `json:"excludeResourceIds,omitempty"`
	RegionAffinity      int      `json:"regionAffinity,omitempty"`

	// StartParameter 设置该字段后，可以提升可用性并优化负载均衡。
	//
	// 注意：如果填写该字段，则必须确保 startParameter object 和后续 start 请求中填写的 clientRequest object 完全一致，
	// 且取值合法，否则 start 请求会收到报错。
	StartParameter *StartWebRecordingClientRequest `json:"startParameter,omitempty"`
}

type Client

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

func NewClient

func NewClient(
	acquireAPI *api.Acquire,
	startAPI *api.Start,
	stopAPI *api.Stop,
	queryAPI *api.Query,
	updateLayoutAPI *api.UpdateLayout,
	updateAPI *api.Update,
) *Client

func (*Client) Acquire

func (c *Client) Acquire(ctx context.Context, cname string, uid string, clientRequest *AcquireWebRecodingClientRequest) (*api.AcquireResp, error)

func (*Client) Query

func (c *Client) Query(ctx context.Context, resourceID string, sid string) (*QueryWebRecordingResp, error)

func (*Client) Start

func (c *Client) Start(ctx context.Context, resourceID string, cname string, uid string, clientRequest *StartWebRecordingClientRequest) (*api.StartResp, error)

func (*Client) Stop

func (c *Client) Stop(ctx context.Context, resourceID string, sid string, cname string, uid string, asyncStop bool) (*api.StopResp, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, resourceID string, sid string, cname string, uid string, clientRequest *UpdateWebRecordingClientRequest) (*api.UpdateResp, error)

type QueryWebRecordingResp

type QueryWebRecordingResp struct {
	api.Response
	SuccessResponse QueryWebRecordingSuccessResp
}

type QueryWebRecordingSuccessResp

type QueryWebRecordingSuccessResp struct {
	ResourceId     string
	Sid            string
	ServerResponse *api.QueryWebRecordingServerResponse
}

type StartWebRecordingClientRequest

type StartWebRecordingClientRequest struct {
	RecordingFileConfig    *api.RecordingFileConfig
	StorageConfig          *api.StorageConfig
	ExtensionServiceConfig *api.ExtensionServiceConfig
}

type UpdateWebRecordingClientRequest

type UpdateWebRecordingClientRequest struct {
	WebRecordingConfig *api.UpdateWebRecordingConfig
	RtmpPublishConfig  *api.UpdateRtmpPublishConfig
}