Merge pull request #35 from seymourtang/doc-cloudrecording

feat:Add QueryRtmpPublish api for web recording

Author: seymourtang

examples/cloudrecording/webrecording/service.go

@@ -222,7 +222,7 @@ func (s *Scenario) RunWebRecorderAndRtmpPublish(storageConfig *cloudRecordingAPI
 
 	// query
 	for i := 0; i < 3; i++ {
-		queryResp, err := s.CloudRecordingClient.WebRecording().Query(ctx, resourceId, sid)
+		queryResp, err := s.CloudRecordingClient.WebRecording().QueryRtmpPublish(ctx, resourceId, sid)
 		if err != nil {
 			log.Println(err)
 			return

services/cloudrecording/resp/webrecording.go

@@ -23,3 +23,25 @@ type QueryWebRecordingSuccessResp struct {
 	// Server response, see QueryWebRecordingServerResponse for details
 	ServerResponse *api.QueryWebRecordingServerResponse
 }
+
+// @brief Response returned by the web recording QueryRtmpPublish API.
+//
+// @since v0.8.0
+type QueryRtmpPublishResp struct {
+	// Response returned by the cloud recording API, see Response for details
+	api.Response
+	// Success response, see QueryRtmpPublishSuccessResp for details
+	SuccessResponse QueryRtmpPublishSuccessResp
+}
+
+// @brief Successful response returned by the web recording QueryRtmpPublish API.
+//
+// @since v0.8.0
+type QueryRtmpPublishSuccessResp struct {
+	// Unique identifier of the resource
+	ResourceId string
+	// Unique identifier of the recording session
+	Sid string
+	// Server response, see QueryRtmpPublishServerResponse for details
+	ServerResponse *api.QueryRtmpPublishServerResponse
+}

services/cloudrecording/scenario/webrecording.go

@@ -135,6 +135,40 @@ func (w *WebRecording) Query(ctx context.Context, resourceID string, sid string)
 	return &webResp, nil
 }
 
+// @brief Query the status of pushing web page recording to the CDN.
+//
+// @since v0.8.0
+//
+// @param ctx Context to control the request lifecycle.
+//
+// @param resourceID The resource ID.
+//
+// @param sid The recording ID, identifying a recording cycle.
+//
+// @return Returns the response *QueryRtmpPublishResp. See resp.QueryRtmpPublishResp for details.
+//
+// @return Returns an error object. If the request fails, the error object is not nil and contains error information.
+func (w *WebRecording) QueryRtmpPublish(ctx context.Context, resourceID string, sid string) (*resp.QueryRtmpPublishResp, error) {
+	respData, err := w.queryAPI.Do(ctx, resourceID, sid, api.WebMode)
+	if err != nil {
+		return nil, err
+	}
+
+	var webResp resp.QueryRtmpPublishResp
+
+	webResp.Response = respData.Response
+	if respData.IsSuccess() {
+		successResp := respData.SuccessResponse
+		webResp.SuccessResponse = resp.QueryRtmpPublishSuccessResp{
+			ResourceId:     successResp.ResourceId,
+			Sid:            successResp.Sid,
+			ServerResponse: successResp.GetRtmpPublishServiceServerResponse(),
+		}
+	}
+
+	return &webResp, nil
+}
+
 // @brief Update web recording configuration.
 //
 // @since v0.8.0