Method StopDesktopRecording

codersdk/workspacesdk/agentconn.go:760–776

StopDesktopRecording stops a desktop recording session on the agent and returns the recording as a StopDesktopRecordingResponse. The response body is a multipart/mixed stream containing the video (and optionally a JPEG thumbnail). The caller is responsible for closing the returned Body. Idempotent —

(ctx context.Context, req StopDesktopRecordingRequest)

// responsible for closing the returned Body. Idempotent — safe
// to call on an already-stopped recording.
func (c *agentConn) StopDesktopRecording(ctx context.Context, req StopDesktopRecordingRequest) (StopDesktopRecordingResponse, error) {
	ctx, span := tracing.StartSpan(ctx)
	defer span.End()
	res, err := c.apiRequest(ctx, http.MethodPost, "/api/v0/desktop/recording/stop", req)
	if err != nil {
		return StopDesktopRecordingResponse{}, xerrors.Errorf("stop recording request: %w", err)
	}
	if res.StatusCode != http.StatusOK {
		defer res.Body.Close()
		return StopDesktopRecordingResponse{}, codersdk.ReadBodyAsError(res)
	}
	// Caller is responsible for closing res.Body.
	return StopDesktopRecordingResponse{
		Body:        res.Body,
		ContentType: res.Header.Get("Content-Type"),
	}, nil
}

// DeleteDevcontainer deletes the provided devcontainer.
// This is a blocking call and will wait for the container to be deleted.