Method StartDesktopRecording

codersdk/workspacesdk/agentconn.go:740–752

StartDesktopRecording starts a desktop recording session on the agent with the given recording ID. The recording ID is caller-provided and must be unique. Idempotent — if the ID is already recording, returns success.

(ctx context.Context, req StartDesktopRecordingRequest)

// caller-provided and must be unique. Idempotent — if the ID is
// already recording, returns success.
func (c *agentConn) StartDesktopRecording(ctx context.Context, req StartDesktopRecordingRequest) error {
	ctx, span := tracing.StartSpan(ctx)
	defer span.End()
	res, err := c.apiRequest(ctx, http.MethodPost, "/api/v0/desktop/recording/start", req)
	if err != nil {
		return xerrors.Errorf("start recording request: %w", err)
	}
	defer res.Body.Close()
	if res.StatusCode != http.StatusOK {
		return codersdk.ReadBodyAsError(res)
	}
	return nil
}

// StopDesktopRecording stops a desktop recording session on the
// agent and returns the recording as a StopDesktopRecordingResponse.